summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorConrad Ludgate <conradludgate@gmail.com>2021-11-13 22:45:50 +0000
committerGitHub <noreply@github.com>2021-11-13 22:45:50 +0000
commit46a1dab132a7f5331458d0d8a5872d4c5e9c0ba7 (patch)
tree49d25bde2d6cdcba9d82956fc7564dd3e0e58466 /docs
parent8f91b1410c2bc67e6b3da8a1927da31a9dfb09ab (diff)
fix: dockerfile with correct glibc (#198)
* fix: dockerfile with correct glibc * chore: update server docs
Diffstat (limited to 'docs')
-rw-r--r--docs/server.md39
1 files changed, 35 insertions, 4 deletions
diff --git a/docs/server.md b/docs/server.md
index 445aacdd..650934b5 100644
--- a/docs/server.md
+++ b/docs/server.md
@@ -19,19 +19,50 @@ OPTIONS:
-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"
```
-`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.
+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 post 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.