160 lines
3.3 KiB
Markdown
160 lines
3.3 KiB
Markdown
# `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>
|
|
```
|
|
|
|
## 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.
|
|
|
|
## Docker
|
|
|
|
There is a supplied docker image to make deploying a server as a container easier.
|
|
|
|
```sh
|
|
docker run -d -v "$USER/.config/atuin:/config" ghcr.io/ellie/atuin:latest server start
|
|
```
|
|
|
|
## Docker Compose
|
|
|
|
Using the already build docker image hosting your own Atuin can be done using the supplied docker-compose file.
|
|
|
|
Create a `.env` file next to `docker-compose.yml` with contents like this:
|
|
|
|
```
|
|
ATUIN_DB_USERNAME=atuin
|
|
# Choose your own secure password
|
|
ATUIN_DB_PASSWORD=really-insecure
|
|
```
|
|
|
|
Create a `docker-compose.yml`:
|
|
|
|
```yaml
|
|
version: '3.5'
|
|
services:
|
|
atuin:
|
|
restart: always
|
|
image: ghcr.io/ellie/atuin:main
|
|
command: server start
|
|
volumes:
|
|
- "./config:/config"
|
|
links:
|
|
- postgresql:db
|
|
ports:
|
|
- 8888:8888
|
|
environment:
|
|
ATUIN_HOST: "0.0.0.0"
|
|
ATUIN_OPEN_REGISTRATION: "true"
|
|
ATUIN_DB_URI: postgres://$ATUIN_DB_USERNAME:$ATUIN_DB_PASSWORD@db/atuin
|
|
postgresql:
|
|
image: postgres:14
|
|
restart: unless-stopped
|
|
volumes: # Don't remove permanent storage for index database files!
|
|
- "./database:/var/lib/postgresql/data/"
|
|
environment:
|
|
POSTGRES_USER: $ATUIN_DB_USERNAME
|
|
POSTGRES_PASSWORD: $ATUIN_DB_PASSWORD
|
|
POSTGRES_DB: atuin
|
|
```
|
|
|
|
Start the services using `docker-compose`:
|
|
|
|
```sh
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Using systemd to manage your atuin server
|
|
|
|
The following `systemd` unit file to manage your `docker-compose` managed service:
|
|
|
|
```
|
|
[Unit]
|
|
Description=Docker Compose Atuin Service
|
|
Requires=docker.service
|
|
After=docker.service
|
|
|
|
[Service]
|
|
# Where the docker-compose file is located
|
|
WorkingDirectory=/srv/atuin-server
|
|
ExecStart=/usr/bin/docker-compose up
|
|
ExecStop=/usr/bin/docker-compose down
|
|
TimeoutStartSec=0
|
|
Restart=on-failure
|
|
StartLimitBurst=3
|
|
|
|
[Install]
|
|
WantedBy=multi-user.target
|
|
```
|
|
|
|
Start and enable the service with:
|
|
|
|
```sh
|
|
systemctl enable --now atuin
|
|
```
|
|
|
|
Check if its running with:
|
|
|
|
```sh
|
|
systemctl status atuin
|
|
```
|
|
|