diff options
author | Ellie Huxtable <e@elm.sh> | 2021-05-07 16:58:57 +0100 |
---|---|---|
committer | Ellie Huxtable <e@elm.sh> | 2021-05-07 16:59:12 +0100 |
commit | cbb472bba66f4f8664dd1ab0be039910d1980c02 (patch) | |
tree | 973cd009fc8b531bbe968b7dbfd12680579a1f97 /docs | |
parent | 6cc5006b106643d9b2f00448e713d152611637e2 (diff) |
Update README and docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/server.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/server.md b/docs/server.md new file mode 100644 index 00000000..445aacdd --- /dev/null +++ b/docs/server.md @@ -0,0 +1,37 @@ +# `atuin server` + +Atuin allows you to run your own sync server, in case you don't want to use the +one I host :) + +There's currently only one subcommand, `atuin server start` which will start the +Atuin http sync server + +``` +USAGE: + atuin server start [OPTIONS] + +FLAGS: + --help Prints help information + -V, --version Prints version information + +OPTIONS: + -h, --host <host> + -p, --port <port> +``` + +The config for the server is kept separate from the config for the client, even +though they are the same binary. Server config can be found at +`~/.config/atuin/server.toml`. + +It looks something like this: + +``` +host = "0.0.0.0" +port = 8888 +open_registration = true +db_uri="postgres://user:password@hostname/database" +``` + +`open_registration` sets whether the server allows new user registrations. Set +this to false after making your own account if you don't want others to be able +to use your server. |