How to set up ArchiSteamFarm on SynologyNAS via Docker and Portainer

ASF_SynologyNAS_TutorialV2.md

Installing ArchiSteamFarm on SynologyNAS: A Comprehensive Guide

This guide will walk you through installing ArchiSteamFarm on your Synology NAS. While tailored for Synology users, the general steps are adaptable to other NAS platforms.

Before We Begin:

1. Set Up Custom DDNS: Go to this guide, follow the instructions, and return here.

2. Set Up Wildcard Certificate: Follow this guide until Step 7, then return here.

---

Installation Steps:

1. Install Docker and Portainer: Visit this guide by Marius Bogdan Lixandru, which explains how to install both Docker and Portainer on Synology NAS.

---

2. Prepare Reverse Proxy for ASF:
   • Head over to this guide and follow the steps until Step 6.
   • In the General section, set the Reverse Proxy Name to ArchiSteamFarm.
   • Add the following under "Source":
     • Protocol: HTTPS
     • Hostname: asf.yourname.synology.me

     Replace "yourname" with whatever name you chose while setting up the DDNS.

     • Port: 443
     • Check Enable HSTS
   • Under "Destination":
     • Protocol: HTTP
     • Hostname: localhost
     • Port: 1242

---

Expected Configuration:

---

3. Creating Folders: Now, return to this guide and follow the steps until Step 10. (Do not complete Step 10!) Instead of creating a folder named "archivebox," create a folder called ASF. Inside this folder, create three subfolders:

   • plugins
   • logs
   • config

   Folder Structure:

   

---

4. Configure ASF on PC:
   • Follow the wiki instructions on how to set up ASF on your PC. This is a one-time step for configuration purposes.
   • Once configured and logged in with your Steam account, proceed to Step 5.

---

5. Transfer Configuration Files:
   • Open the config folder within the downloaded ASF directory on your PC.
   • Locate the previously created config folder on your NAS.
   • Drag and drop all files from the PC's config folder to the NAS's config folder.

---

6. Create and Configure IPC.config:

   • Open the text editor on your NAS.

   • Paste the following code:

     {
         "Kestrel": {
             "Endpoints": {
                 "HTTP": {
                     "Url": "http://*:1242"
                 }
             }
         }
     }

   • Save the file as IPC.config within the /docker/ASF/config folder on your NAS.

---

7. Deploy ASF using Portainer:

   • Open Portainer and navigate to the settings.
   • Nevigate to the App Templates section.
   • In the URL Paste this: https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
   • Save application settings and go to Templates > Application.

   

   • Follow the screenshot bellow and click on the ArchiSteamFarm template.
   • Find your UID and GID using this guide.
   • Replace both PUID and PGID numbers in the template with the ones you recived from the email. (They are named UID and GID)
   • Click on Show advanced options
   • Copy these lines and put them exactly like how i did it in the image below:
   1. /volume1/docker/ASF/config
   2. /volume1/docker/ASF/logs
   3. /volume1/docker/ASF/plugins

   Expected Configuration:

   • Scroll down and click "Deploy the container."
   • Wait for a few minutes for deployment to complete. You should see something like a "Container successfully deployed" notification.

8. Access ASF:

   • Open a new web browser window and navigate to https://asf.yourname.synology.me (replace "yourname" with the custom DDNS you made earlier).
   • If everything is configured correctly, you should see the ASF login page!

---

9. Optional Step: Container Management Go to the Containers section in Portainer and search for a container with a name similar to archisteamfarm. If you want to rename it, click on the container name and press the Edit button. Rename the container as desired.

If you want the container to automatically restart after crashes or power outages, scroll to the bottom of the page, find the RESTART POLICIES in the "Container details" area, and set it to Unless Stopped. Hit Update.

Congratulations!

You’ve successfully set up ArchiSteamFarm on your SynologyNAS! 🥳

---

Sources and Credits:

• Special thanks to Marius Bogdan Lixandru for creating the guides that inspired this tutorial. You can support his work here.
• Thanks to Portainer Templates for providing the template I used and modified.
• And of course, a little credit to me for writing this tutorial! 😉

Awesome stuff. Helped me significantly, especially after not using ASF for many years. Only issue I ran into was not changing the default ASF.json file, so ran into IPCPassword issues. It's not an error on your part, just my laziness. Cheers.

Awesome stuff. Helped me significantly, especially after not using ASF for many years. Only issue I ran into was not changing the default ASF.json file, so ran into IPCPassword issues. It's not an error on your part, just my laziness. Cheers.

Thanks for checking out my tutorial, I had a feeling people might run into IPCPassword issues because I couldn’t remember how I set it up myself but they can always look at the official ASF Wiki to see how to set it up 👍🏻

Thanks a lot, great guide!

I just have a small issue with permissions, like:
"[14:09:24] ERROR ASF > Save() System.UnauthorizedAccessException: Access to the path '/app/config/x.db.new' is denied."

Any idea what I could do?

Thanks a lot, great guide!

I just have a small issue with permissions, like: "[14:09:24] ERROR ASF > Save() System.UnauthorizedAccessException: Access to the path '/app/config/x.db.new' is denied."

Any idea what I could do?

It might be either a bug with ASF or that you didn’t set correct permissions in the folder, have you using the docker folder on Synology before?