From 2dda1b613af539a41e6aaad2a365e5d0dbbab544 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 18 Oct 2023 17:26:07 +0200 Subject: [PATCH] Rearrange and organize sections. --- .vitepress/config.ts | 4 ++++ docs/configuration.md | 30 --------------------------- docs/installation/debian.md | 17 ++------------- docs/running-the-server.md | 41 +++++++++++++++++++++++++++++++++++++ 4 files changed, 47 insertions(+), 45 deletions(-) create mode 100644 docs/running-the-server.md diff --git a/.vitepress/config.ts b/.vitepress/config.ts index de6e3e1..fb7ea62 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -55,6 +55,10 @@ export default defineConfig({ ] }, ] + }, + { + text: 'Running the server', + link: '/docs/running-the-server', } ] }, diff --git a/docs/configuration.md b/docs/configuration.md index 0ab101b..1f6442d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -9,33 +9,3 @@ api: "http://api.example.com:8888" ship: url: "ws://ship.example.com:8080" ``` - -## Start using scripts - -Start the server using the `start.sh` script. - -```shell -./start.sh -``` - -The logs can be found in `logs` directory (unless specified otherwise in the configuration). - -Stopping the server again is as simple as running. - -```shell -./stop.sh -``` - -## Starting Manually - -If desired, Thalos can also be started manually for quick configuration testing. - -```shell -./bin/thalos-server -``` - -or if you want to specify another config file then the default - -```shell -./bin/thalos-server --config /path/to/thalos.yml -``` diff --git a/docs/installation/debian.md b/docs/installation/debian.md index e4a7e47..ba1b396 100644 --- a/docs/installation/debian.md +++ b/docs/installation/debian.md @@ -50,19 +50,6 @@ The configuration file is located at `/etc/thalos/config.yml` and contains an ex See [Configuration](/docs/configuration) for more information -## 3. Starting the Server via systemd +## 3. Starting the Server -```shell -sudo systemctl enable thalos-server -sudo systemctl start thalos-server -``` - -After executing these commands, the server should be up and running. You can check the logs at `/var/log/thalos.log` (unless specified otherwise in the configuration), or by running `sudo systemctl status thalos-server`. - -### Starting Manually - -If desired, Thalos can also be started manually for quick configuration testing or in cases where running systemd is not preferable: - -```shell -/usr/bin/thalos-server --config /etc/thalos/thalos.yml -``` +There are serveral ways to run the server. the most common on debian is via [systemd](/docs/running-the-server#with-systemd) or [manually](/docs/running-the-server#with-systemd) diff --git a/docs/running-the-server.md b/docs/running-the-server.md new file mode 100644 index 0000000..743957b --- /dev/null +++ b/docs/running-the-server.md @@ -0,0 +1,41 @@ +# Running the server + +## Start using scripts + +Start the server using the `start.sh` script. + +```shell +./start.sh +``` + +The logs can be found in `logs` directory (unless specified otherwise in the configuration). + +Stopping the server again is as simple as running. + +```shell +./stop.sh +``` + +## Starting Manually + +If desired, Thalos can also be started manually for quick configuration testing. + +```shell +./bin/thalos-server +``` + +or if you want to specify another config file then the default + +```shell +./bin/thalos-server --config /path/to/thalos.yml +``` + +## With systemd + +```shell +sudo systemctl enable thalos-server +sudo systemctl start thalos-server +``` + +After executing these commands, the server should be up and running. You can check the logs at `/var/log/thalos.log` (unless specified otherwise in the configuration), or by running `sudo systemctl status thalos-server`. +