FarmOS is a web-based application for farm management, planning, and record keeping. It is developed by a community of farmers, developers, researchers, and organizations with the aim of providing a standard platform for agricultural data collection and management. In this step by step guide I will show you how to install FarmOS on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest FarmOS v3.3.1 release.

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it farmos. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 4

Now create two new folders inside the farmos folder that you created at STEP 3 and name them db and sites. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 5

Download (click on the blue link below) then unzip and upload the php.ini file below in the farmos folder that you have previously created at STEP 3. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻Download php.ini

• STEP 6

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 7

In the Name field type in farmos. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.9"
services:
  db:
    image: postgres:16
    container_name: FarmOS-DB
    hostname: farmos-db
    mem_limit: 1g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "farmos", "-U", "farmosuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/farmos/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: farmos
      POSTGRES_USER: farmosuser
      POSTGRES_PASSWORD: farmospass
    restart: on-failure:5

  farmos:
    image: farmos/farmos:latest
    container_name: FarmOS
    hostname: farmos
    security_opt:
      - no-new-privileges:true
    ports:
      - 7917:80
    volumes:
      - /volume1/docker/farmos/php.ini:/usr/local/etc/php/conf.d/farmos.ini:rw
      - /volume1/docker/farmos/sites:/opt/drupal/web/sites:rw
    restart: on-failure:5
    depends_on:
      db:
        condition: service_healthy

• STEP 8

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

⌛Now just wait because the FarmOS image is about 1GB.

• STEP 9

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 10

Go back to STEP 1 or you will deal with karma 🙂

• STEP 11

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:7917 Follow the instructions in the image below.

Select PostgreSQL as a Database type, then add the following details.

Database name: farmos
Database username: farmosuser
Database password: farmospass

ADVANCED OPTIONS

Host: farmos-db
Port number: 5432
Table name prefix: farm_

• STEP 12

Click Save and Continue. Follow the instructions in the image below.

⚠️Warning: If you can’t connect to the database, make sure you have followed the Firewall guide, especially RULE 5 and RULE 6.

• STEP 13

Wait until the User module is installed. Follow the instructions in the image below.

• STEP 14

Add your own personal information. Follow the instructions in the image below.

• STEP 15

After you have added your personal information, click Save and continue. Follow the instructions in the image below.

• STEP 16

Select the modules that you want to install. I have selected the default ones. Note: Keep in mind, the more modules you select, the longer the installation takes. Scroll down the page until you find the Save and continue button. Follow the instructions in the image below.

• STEP 17

Click Save and continue. Follow the instructions in the image below.

• STEP 18

Wait until all your modules are installed. Note: The process can take a long time. Follow the instructions in the image below.

• STEP 19

Your FarmOS dashboard at a glance!

Enjoy FarmOS!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the FarmOS container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make FarmOS work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the FarmOS container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Wednesday / November 6th, 2024 at 3:28 AM