Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add documentation for installing waymond as a Systemd Service #30

Merged
merged 3 commits into from
Aug 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion site/docs/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,33 @@ The only way to run waymond right now is
waymond -config waymond.toml
```

But the project is looking to improve the CLI experience. So, please take a look [here](https://github.com/scriptnull/waymond/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcli) if you would like to contribute.
## Run as a Systemd Service
After downloading the binary to `/usr/bin` directory, create a new service unit file in the `/etc/systemd/system` directory named `waymond.service`:

```
[Unit]
Description=An Awesome Autoscaler Service
After=network.target

[Service]
ExecStart=/usr/bin/waymond -config /path/to/config/file
WorkingDirectory=/usr/bin
Restart=always
RestartSec=10
User=your_user
Group=your_group

[Install]
WantedBy=multi-user.target
```
Reload the systemd manager configuration to apply the new service:
```sudo systemctl daemon-reload```

Enable the service to start on boot:

```sudo systemctl enable waymond.service```

Start the service:

```sudo systemctl start waymond.service```

Loading