Skip to content

Getting started

Follow these instructions to set up a local farmOS development environment.

The only requirements are Docker and Docker Compose.

1. Set up Docker containers

Run the following commands to create a farmOS directory and set up Docker containers for farmOS and PostgreSQL:

mkdir farmOS && cd farmOS
curl https://raw.githubusercontent.com/farmOS/farmOS/2.x/docker/docker-compose.development.yml -o docker-compose.yml
docker-compose up -d

2. Install farmOS

Open http://localhost in a browser and install farmOS with the following database credentials:

  • Database type: PostgreSQL
  • Database name: farm
  • Database user: farm
  • Database password: farm
  • Advanced options > Host: db

3. Develop

Open the www directory in your favorite IDE.

Optional

Configure private filesystem

In order to upload files, a private file path must be configured. The following line must be added to www/web/sites/default/settings.php:

$settings['file_private_path'] = '/opt/drupal/web/sites/default/private/files';

Configure debugger

See Debugging.

Enable HTTPS

See HTTPS.