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.

Sign up for GitHub

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

docs: Add description how to start Device Agent on system boot #4878

Merged
merged 1 commit into from
Dec 5, 2024
Merged

docs: Add description how to start Device Agent on system boot #4878

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions docs/device-agent/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,42 @@ the same machine.
flowfuse-device-agent --port=1881
```

### Start Device Agent on system boot

To start the device agent on system boot, you can use the provided systemd service file.

1. Download the file:

```bash
curl -L https://raw.githubusercontent.com/FlowFuse/device-agent/refs/heads/main/service/flowfuse-device.service -o flowfuse-device.service
```

2. Adjust `User`, `Group` and `WorkingDirectory` if needed
3. Change the `ExecStart` command to start the Agent on [different port](#listen-port), if needed
4. Move the service file to `/etc/systemd/system/` directory

```bash
sudo mv flowfuse-device.service /etc/systemd/system/
```

5. Reload the systemd daemon

```bash
sudo systemctl daemon-reload
```

6. Enable the service to start on boot

```bash
sudo systemctl enable flowfuse-device
```

7. Start the service

```bash
sudo systemctl start flowfuse-device
```

## Upgrading the agent

To use the latest features on FlowFuse as well as on the edge device, it is advised to upgrade
Expand Down
Loading