Skip to content

docs(server): add systemd user-service setup for openviking-server#1543

Open
Gujiassh wants to merge 1 commit intovolcengine:mainfrom
Gujiassh:fix/systemd-user-service-docs
Open

docs(server): add systemd user-service setup for openviking-server#1543
Gujiassh wants to merge 1 commit intovolcengine:mainfrom
Gujiassh:fix/systemd-user-service-docs

Conversation

@Gujiassh
Copy link
Copy Markdown
Contributor

Summary

  • add a user-level systemd service example for openviking-server
  • document the quickstart flow for enabling and running it without a root-managed unit

Validation

  • docs-only change

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 95
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Documentation Consistency

PR updates only English documentation; Chinese and Japanese translations are missing for the new systemd user service section.

## Run with systemd user service (recommended for Linux)

`openviking-server` runs in the foreground. For persistent Linux sessions, use a user-level systemd unit instead of shell background wrappers.

1. Copy the example unit file:

```bash
mkdir -p ~/.config/systemd/user
cp docs/en/getting-started/examples/openviking-server.service ~/.config/systemd/user/openviking.service
  1. Edit the unit values:
  • Set WorkingDirectory to your OpenViking workspace
  • Set Environment=OPENVIKING_CONFIG_FILE=... to your ov.conf path
  • Optionally add Environment=OPENVIKING_CLI_CONFIG_FILE=... if needed
  1. Enable and start:
systemctl --user daemon-reload
systemctl --user enable --now openviking.service
systemctl --user status openviking.service
  1. View logs:
journalctl --user -u openviking.service -f

</details>

</td></tr>
</table>

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant