feat: Add Portracker service with Synology setup guides and scripts

This commit is contained in:
2026-02-22 12:56:05 -05:00
parent 5ba88c9ae4
commit 070e03eafb
3 changed files with 77 additions and 0 deletions

37
portracker/SETUP.md Normal file
View File

@@ -0,0 +1,37 @@
# Service Setup Guide: Portracker
Portracker is a real-time port monitoring and service discovery tool.
## 1. Pre-Setup (Manual)
### Create Service User
- [ ] **Manual**: Create a local user named `svc-portracker` in Synology DSM (Control Panel > User & Group).
- [ ] **Manual**: Give this user read/write access to the `docker` shared folder.
### Get User IDs
- [ ] **Manual**: SSH into your NAS and run `id svc-portracker`.
- [ ] **Action**: Record the `uid` (PUID) and `gid` (PGID) for use in Portainer.
## 2. Infrastructure Setup
### Run Setup Script
- [ ] **Action**: Run the setup script to initialize the data directory:
```bash
sudo bash create_portracker_folders.sh
```
- **What it does**:
- Creates `/volume1/docker/portracker/data`.
- Sets ownership to the `svc-portracker` user (Note: You may need to edit the script with your specific PUID/PGID before running).
## 3. Portainer Deployment
### Environment Variables
- [ ] **Action**: In the Portainer Stack configuration, add the following environment variables:
- `PUID=[Your UID]`
- `PGID=[Your GID]`
- `TZ=[Your Timezone, e.g., America/Toronto]`
### Deploy Stack
- [ ] **Action**: Create a new stack named `portracker`.
- [ ] **Action**: Paste the content of `docker-compose.portainer.yml` and deploy.
- [ ] **Verification**: Access the dashboard at `http://[NAS_IP]:4999`.
> [!NOTE]
> This service requires access to the Docker socket and host PID to monitor network services. It runs with elevated capabilities (`SYS_PTRACE`, `SYS_ADMIN`).