Updated Home (markdown)

Roni Väyrynen
2022-07-29 14:21:15 +03:00
parent 782890f7ee
commit e925702a00

22
Home.md

@@ -8,11 +8,11 @@ Start off by copying the sample configuration if not done already:
cp sample.xo-install.cfg xo-install.cfg
```
#### HTTPS
### HTTPS
There's few different ways to enable HTTPS for Xen Orchestra.
* Let's Encrypt, automatically created by Xen Orchestra
#### Let's Encrypt, automatically created by Xen Orchestra
Edit `xo-install.cfg` with your preferred text editor and make sure following variables are set:
@@ -24,9 +24,9 @@ Additionally you can set `LETSENCRYPT_EMAIL="your@email.tld"` to receive notific
Enabling Let's Encrypt overwrites some other configuration options so that it works properly, these are:
PORT is set to 80
AUTOCERT is set to true
Certificate and Key paths are set to `./certificate.pem` and `./key.pem`, meaning they will be located in same directory with xo-server config.toml file.
- PORT is set to 80
- AUTOCERT is set to true
- Certificate and Key paths are set to `./certificate.pem` and `./key.pem`, meaning they will be located in same directory with xo-server config.toml file.
Certificate will be generated when XO is accessed first time from browser with domain set in configuration. When this is done for the first time, the page will load slightly longer due to certificate being generated.
@@ -36,7 +36,7 @@ Check these if certificate generation doesn't work properly:
- If certificate/key paths were set before and there are existing files, XO won't generate a new Let's Encrypt certificate. Stop xo-server, remove/rename these files and restart xo-server.
* Self-signed certificate, automatically created by Xen Orchestra
#### Self-signed certificate, automatically created by Xen Orchestra
Edit `xo-install.cfg` with your preferred text editor and make sure following variables are set:
@@ -50,7 +50,7 @@ AUTOCERT="true"
```
Now whenever install/update is ran with `xo-install.sh`, after xo-server service is started a new certificate/key pair is created to `/opt/xo/xo.crt`/`/opt/xo/xo.key` and Xen Orchestra will use them. `AUTOCERT` option will ensure that these files are autogenerated if they do not exist.
* Self-signed certificate, manually created
#### Self-signed certificate, manually created
Generate certificate/key pair with openssl:
@@ -69,7 +69,7 @@ PATH_TO_HTTPS_KEY="/etc/ssl/xo/key.pem"
Run install/update with `xo-install.sh`
* Use existing certificate
#### Use existing certificate
If you have existing certificate you want to use, just make sure following settings are present in xo-install.cfg:
@@ -84,7 +84,7 @@ Run install/update with `xo-install.sh`
Note that if using non-root user in `xo-install.cfg`, this user needs to have appropriate read (or read/write if AUTOCERT is set to true) permissions to directory where defined certificate/key are located.
#### Non-root user
### Non-root user
Script fully supports using a non-root user to run Xen Orchestra and will take care of everything for you. Couple things to note: script still needs to be run as root and any SELinux related permissions aren't modified.
@@ -102,7 +102,7 @@ USESUDO="true"
GENSUDO="true"
```
#### Running on non supported OS/Architecture
### Running on non supported OS/Architecture
By default script refuses to run on any other than list of supported operating systems, versions and architecture. This doesn't mean script won't work on some other rpm/deb variant, this is simply to keep the list manageable as there's very little reasons to install Xen Orchestra on an unsupported OS.
@@ -113,7 +113,7 @@ OS_CHECK="false"
ARCH_CHECK="false"
```
#### Custom non supported Xen Orchestra configuration
### Custom non supported Xen Orchestra configuration
Script supports a set of configuration options defined in `xo-install.cfg`. Some of these edit the final xo-server configuration file (by default stored in `$HOME/.config/xo-server/config.toml`). In some cases you might've chosen to edit this configuration by hand but still want to run updates with `xo-install.sh`. With default settings, this configuration file would be overwritten with every update. There is option to disable this behaviour and keep existing configuration file: