diff options
| author | Ellie Huxtable <ellie@elliehuxtable.com> | 2023-02-25 23:29:59 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-25 23:29:59 +0000 |
| commit | c558da5bebfebf239dde867f36cc35d56849accf (patch) | |
| tree | 2e75e2c479fa1d89632eafd8119e084243bafa5e /docs/server.md | |
| parent | Revert "Remove shortcut numbers (#708)" (#724) (diff) | |
| download | atuin-c558da5bebfebf239dde867f36cc35d56849accf.zip | |
Add fancy web docs (#725)
* Add initial site
* WIP again
* Replace docs with web docs
* Bring back translations
* Update README.md
* remove images
Diffstat (limited to 'docs/server.md')
| -rw-r--r-- | docs/server.md | 81 |
1 files changed, 0 insertions, 81 deletions
diff --git a/docs/server.md b/docs/server.md deleted file mode 100644 index beb9645f..00000000 --- a/docs/server.md +++ /dev/null @@ -1,81 +0,0 @@ -# `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: - -h, --help Prints help information - -V, --version Prints version information - -OPTIONS: - --host <host> - -p, --port <port> -``` - -## Configuration - -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: - -```toml -host = "0.0.0.0" -port = 8888 -open_registration = true -db_uri="postgres://user:password@hostname/database" -``` - -Alternatively, configuration can also be provided with environment variables. - -```sh -ATUIN_HOST="0.0.0.0" -ATUIN_PORT=8888 -ATUIN_OPEN_REGISTRATION=true -ATUIN_DB_URI="postgres://user:password@hostname/database" -``` - -### host - -The host address the atuin server should listen on. - -Defaults to `127.0.0.1`. - -### port - -The port the atuin server should listen on. - -Defaults to `8888`. - -### open_registration - -If `true`, atuin will accept 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. - -Defaults to `false`. - -### db_uri - -A valid postgres URI, where the user and history data will be saved to. - -### path - -A path to prepend to all the routes of the server. Any empty string means that nothing will be prepended. - -Defaults to `""` - -## Container deployment instructions - -You can deploy you own atuin server in a container: - -* See [docker](docker.md) for a sample docker configuration. -* See [k8s](k8s.md) for a sample kubernetes configuration. |