XOA won't start HTTPS listen on configured port

bill.gertz

Thanks again for the help, and will submit a PR but under which repo for the documentation? Looks like your using GitBook and I'm clueless on submitting PRs on GitBook. Is there some sort of way to submit changes to your doc set from within GitBook?

I ran into the problem anyway due to the load any toml behavior. xo-server startup loaded my backup of the original config (config.toml.orig). That was not really expected.

julien-f

This is already correctly documented: https://github.com/vatesfr/xen-orchestra/blob/377552103eabbf99d12101136fc8b37eb8f2dcf4/packages/xo-server/sample.config.toml#L3-L5

Avoid using .xo-server.toml as they are relative to the current working directory (similar to other command tools like Git).

bill.gertz

@julien-f @olivierlambert

Thanks for getting back to me, not trying to pick a fight. Loading config.toml.orig is not clear based on what the comments say:

# This file is automatically looking for at the following places:
# - `$HOME/.config/xo-server/config.toml`
# - `/etc/xo-server/config.toml`

xo-server is loading config.toml.orig that just doesn't seem to square with the comments. If it's documented elsewhere in the file and I just missed it please help me find it Just the same shouldn't this behavior be documented in https://xen-orchestra.com/docs/configuration.html? I can't be the only person to make .orig style backup copies before making changes?

julien-f

@bill-gertz Indeed I missed this, xo-server loads all files named config.* with a known extension.

I have to take a look at why it loads a .orig.

bill.gertz

@julien-f

Along with .xo-server.toml as you pointed out earlier and I've experienced :-/. Thanks again for looking into this.

julien-f

@bill-gertz AFAICT, this is a log issue, the file .orig is not taken into account for the configuration, I'll fix this.

Regarding .xo-server.toml, I will not change anything, it's used by some devs in some specific setups, but it's not documented as it does not make sense for user to do this.

bill.gertz

@julien-f

Again not trying to pick a fight but your own documentation says to use .xo-server.toml here when compiling from the sources.

Shouldn't this be changed from:

Now you have to create a config file for xo-server:

$ cd packages/xo-server
$ cp sample.config.toml .xo-server.toml

To something like:

Now you have to create a config file for xo-server:

$ cd packages/xo-server
$ cp sample.config.toml config.toml

This is what happened when the 3rd party script ran. I can submit PRs for the GitBook docs, but I don't see anyway of doing that from GitBooks. Is there a repo for this GitBook doc in which I can submit a PR? I'll be happy to submit a PR to the 3rd party script repo as well.

julien-f

@bill-gertz said in XOA won't start HTTPS listen on configured port:

Again not trying to pick a fight

Don't worry about this

@bill-gertz said in XOA won't start HTTPS listen on configured port:

your own documentation says to use .xo-server.toml here when compiling from the sources

Hmm, indeed, I will change this to avoid any issues in the future.

@bill-gertz said in XOA won't start HTTPS listen on configured port:

Is there a repo for this GitBook doc in which I can submit a PR?

https://github.com/vatesfr/xen-orchestra/tree/master/docs

bill.gertz

@julien-f

Thanks, I'll lay my cards more directly on the table next time. Glad you're not taking it personally. I'll use that repo for PRs. Thanks again.

julien-f

@bill-gertz I've made the change, the documentation will update soon: https://github.com/vatesfr/xen-orchestra/commit/7b47e4024492d38bca6e928748490e0a4880264c

0

julien-f committed to vatesfr/xen-orchestra

fix(docs/from sources): dont use `.xo-server.toml`

olivierlambert

Thanks for the feedback @bill-gertz !

Thanks for the doc update @julien-f

bill.gertz

@olivierlambert @julien-f @Danp

Thanks to everyone for the clear, helpful support. Impressed.

bill.gertz

@julien-f @olivierlambert

Submitted PR to change attribute documented as 'host' to 'hostname'.
https://github.com/vatesfr/xen-orchestra/pull/4681

billgertz opened this pull request in vatesfr/xen-orchestra

closed fix(docs/configuration): `host` → `hostname` #4681

ronivay

Hi,

@julien-f from sources documentation still instructs to set path relative to packages/xo-server like it used to be:

[http.mounts]
'/' = '../xo-web/dist/'

sample.config.toml says that paths are relative to configuration file so this would end up looking xo-web/dist path from $HOME/.config/ since configuration is at $HOME/.config/xo-server/config.toml

Noticed this while fixing my "well known installer script"

julien-f

@ronivay Thanks for the report, I'll change this by make it part of the default config, it won't be necessary for the user to configure it themself.

julien-f

In fact it's already the case, I just need to remove this from the documentation

https://github.com/vatesfr/xen-orchestra/blob/14f0cbaec6244d66266fe2ee47b0bfb5716c2f61/packages/xo-server/config.toml#L99-L100

julien-f

Done: https://github.com/vatesfr/xen-orchestra/commit/14f0cbaec6244d66266fe2ee47b0bfb5716c2f61

0

julien-f committed to vatesfr/xen-orchestra

fix(docs/from sources): no need to configure `/` mount point

bill.gertz

All,

For anyone that happens into this thread and wondered if the well known installer script was confirmed working correctly. It was fixed as noted above and tested on a fresh install, The rule of thumb, a bit tongue in cheek, when it comes to these files is:

Leave the config in /etc[/xo]/xo-server/config.toml alone.
Set the over rides in ~/.config/xo-server/config.toml home .
Use only /etc[/xo]/xo-server/config.toml and you're on your own.

On the last point point I mean that you need ensure whatever you use there contains attributes for the original file plus your overrides. Copying the sample config packages/xo-server/sample.config.toml to /etc[/xo]/xo-server/config.toml may not capture all of the attributes that need to be set.

@julien-f If missed the spirit of this please, please correct me.

julien-f

@bill-gertz It depends of how you install it, but it look ok. In our appliances we install and run xo-server as a global service, and there is only /etc/xo-server/config.toml which is used for user customization (you could remove it and it would still work).