(Better) Aldryn Setup Guide for Frontend Developers


  • ask the Aldryn administrator to add you as a collaborator to Aldryn
  • You will get a signup email.
  • Add your SSH key here: https://control.aldryn.com/account/ssh-keys/ (if you don’t have one, make one. See System Setup for instructions)

System Setup

Mac OS X:

  • Your SSH key should be in your ~/.ssh/ directory and named id_rsa
  • New one: ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

  • Download and install Docker for Mac: https://docs.docker.com/docker-for-mac/

  • On the command line, execute pip
  • if it doesn’t exist run sudo easy_install pip


  • Your SSH key should be in your ~/.ssh/ directory and named id_rsa
  • New one: ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
  • Install docker: https://docs.docker.com/engine/installation/linux/debian/#


Traditionally with Docker Toolbox

  • Install https://www.divio.com/en/products/aldryn-desktop-app/ and click on Aldryn Local which will set things up for ya.
  • Update the newly installed VirtualBox to the latest version

Manually with new Docker for Windows

  • this doesn’t work with Win10 Non-Pro edition at the time of writing due to limitations in Docker for Windows or Win10.
  • download and install Docker for Windows: https://docs.docker.com/engine/installation/windows/#/docker-for-windows
  • download and install Python for Windows https://docs.python.org/3/using/windows.html (best choose customize installation, install for all users and check add Python to PATH

Aldryn Setup

  • Runpip install aldryn-client
  • Run aldryn login and enter the access token from your https://control.aldryn.com/account/desktop-app/access-token/
  • aldryn project list and get the slug for your project
  • Go to your preferred project directory and run aldryn project setup project-slug (replace project-slug with the slug you got from aldryn project list) – make sure to select a location within your user home directory otherwise it wont work due to OS restrictions!
  • after the setup you should be able to get the project going by running docker-compose up
  • download the media and database from stage by aldryn project pull db and aldryn project pull media if necessary.

Aldryn – Github Integration

  • As Aldryn runs its own git (no GUI) we normally run our Github repo alongside. Here is how to set up:
  • ask the Github administrator to add you to the project repo
  • Add the remote with git remote add what git@github.com:what-digital/project-repo-slug.git
  • Check out the remote branch with git checkout -b "what/develop" what/develop (Aldryn uses develop instead of stage)
  • You can create your own branches to later create proper pull requests on Github: git checkout -b "your-branch" and then git push --set-upstream what your-branch