📕 yarn is a Self-Hosted, Twitter™-like Decentralised micro-Blogging platform. No ads, no tracking, your content, your data! https://yarn.social/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Anthony Bucci b970a56f03 preliminary systemd unit and environment configuration file 2 months ago
systemd preliminary systemd unit and environment configuration file 2 months ago
README.MD Add Deployment Guide Documentation (#933) 6 months ago
traefik.yml Add Deployment Guide Documentation (#933) 6 months ago
yarn.yml Add Deployment Guide Documentation (#933) 6 months ago



This deployment guide assumes you are using Docker with Swarm mode. There are many other ways to deploy this which we will cover eventually, but for now Docker Swarm is fairly simple.


  • A VPS or VM publically accessible
  • A domain name
  • DNS hosted on Cloudflare
  • A cup of coffee


  • Update and configure your VPS/VM how you prefer. Hardening and configuration is out of scope for this guide
  • Ensure ports 80/443(tcp) are open via IPTables or UFW, however you choose to open them
  • Visit cloudflare and point mypoddomain.com to the public-routable IP address of your system, ensure proxy is checked
  • Grab your API key from the Cloudflare interface
  • Install docker on your VPS/VM
  • Create an operator user with wheel or sudo group as well as docker group
  • Execute: docker swarm init, you've now created a single node Docker Swarm Cluster
  • Execute: docker network create -d overlay traefik this will create the network needed for Traefik and Yarn to communicate
  • Execute: docker stack deploy -c traefik.yml traefik this will deploy the traefik stack
  • Give Traefik a few minutes to warm up. Tail the logs with docker logs -f traefik_traefik.1.someid to ensure there are no errors
  • Execute: docker stack deploy -c yarn.yml yarn
  • Execute watch docker stack ps yarn --no-trunc to ensure the stack comes up and reaches running state
  • Execute: docker logs -f yarn_yarn.1.someid to verify the store is merged and service is up
  • If there are no issues, you should be able to visit: https://mypoddomain.com
  • To create your admin user, register with the username and email you set in the yarn.yml file
  • Login to your pod to verify it was successful
  • You can now customise your pod by visiting Settings -> Poderator Settings
  • Grab another coffee