From 048f5fe467e4c1a57f15f250b0b768032b025ea7 Mon Sep 17 00:00:00 2001 From: Caileb Date: Thu, 29 May 2025 15:29:25 -0500 Subject: [PATCH] Add Install on Synology NAS with Portainer --- Install-on-Synology-NAS-with-Portainer.md | 42 +++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 Install-on-Synology-NAS-with-Portainer.md diff --git a/Install-on-Synology-NAS-with-Portainer.md b/Install-on-Synology-NAS-with-Portainer.md new file mode 100644 index 0000000..6590963 --- /dev/null +++ b/Install-on-Synology-NAS-with-Portainer.md @@ -0,0 +1,42 @@ +## 1. Create Skeleton in File Station + +1. Log in to DSM and open **File Station** +2. Navigate to the `docker` folder +3. Click **Create** → **Create folder**, name it **Checkpoint** +4. Inside **Checkpoint**, create three subfolders: + - **data** + - **db** + - **config** (place your configuration TOML files here) +5. Upload your `.env` file if you have one + +--- + +## 2. Deploy stack in Portainer + +1. Open Portainer → **Stacks** → **Add stack** +2. Under **Build method**, choose **Repository** +3. Fill in fields: + - **Repository URL**: `https://git.caileb.com/Caileb/Checkpoint.git` + - **Repository reference**: `refs/heads/master` + - **Compose path**: `docker-compose-synology.yml` +4. If your repo is private, toggle **Authentication** on and enter your credentials or deploy key +5. (Optional) Under **Environment variables**: + - Click **Load variables from .env file** to import your `.env` entries into Portainer +6. Click **Deploy the stack** + +Portainer will: +- Clone your repo to its workspace +- Build the Docker image from your `Dockerfile` +- Start the `checkpoint` container with your volume folders mounted + +--- + +## 4. Verify & manage + +- **Containers**: Portainer → **Containers** → look for **checkpoint** +- **Logs**: Portainer → **Logs** button +- **Settings** / **Redeploy**: Portainer → **Stacks** → **checkpoint** → **Actions** + +--- + +*You're done.* Checkpoint is now running on your Synology NAS! \ No newline at end of file