microblog.pub/docs/install.md

Installing

[TOC]

Docker edition

Assuming Docker and Docker Compose are already installed.

For now, there's no image published on Docker Hub, this means you will have to build the image locally.

Clone the repository, replace you-domain.tld by your own domain.

Note that if you want to serve static assets via your reverse proxy (like nginx), clone it in a place where accessible by your reverse proxy user.

git clone https://git.sr.ht/~tsileo/microblog.pub your-domain.tld

Build the Docker image locally.

make build

Run the configuration wizard.

make config

Update data/profile.toml and add this line in order to process headers from the reverse proxy:

trusted_hosts = ["*"]

Start the app with Docker Compose, it will listen on port 8000 by default. The port can be tweaked in the docker-compose.yml file.

docker compose up -d

Setup a reverse proxy (see the Reverse Proxy section).

Updating

To update microblogpub, pull the latest changes, rebuild the Docker image and restart the process with docker compose.

git pull
make build
docker compose stop
docker compose up -d

As you probably already know, Docker can (and will) eat a lot of disk space, when updating you should prune old images from time to time:

docker image prune -a --filter "until=24h"

Python developer edition

Assuming you have a working Python 3.10+ environment.

Setup Poetry.

curl -sSL https://install.python-poetry.org | python3 -

Clone the repository.

git clone https://git.sr.ht/~tsileo/microblog.pub testing.microblog.pub

Install deps.

poetry install

Setup config.

poetry run inv configuration-wizard

Grab your virtualenv path.

poetry env info

Run the two processes with supervisord.

VENV_DIR=/home/ubuntu/.cache/pypoetry/virtualenvs/microblogpub-chx-y1oE-py3.10 poetry run supervisord -c misc/supervisord.conf -n

Setup a reverse proxy (see the next section).

Updating

To update microblogpub locally, pull the remote changes and run the update task to regeneratee the CSS and run any DB migrations.

git pull
poetry run inv update

Reverse proxy

You will also want to setup a reverse proxy like NGINX, see uvicorn documentation:

If you don't have a reverse proxy setup yet, NGINX + certbot is recommended.

server {
    client_max_body_size 4G;

    location / {
      proxy_set_header Host $http_host;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header X-Forwarded-Proto $scheme;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection $connection_upgrade;
      proxy_redirect off;
      proxy_buffering off;
      proxy_pass http://localhost:8000;
    }

    # [...]
}

Optionally, you can serve static files using NGINX directly, with an additional location block. This will require the NGINX user to have access to the static/ directory.

server {
    # [...]

    location / {
        # [...]
    }

    location /static {
       # path for static files
       rewrite ^/static/(.*) /$1 break;
       root /path/to/your-domain.tld/app/static/;
    }

    # [...]
}

NGINX config tips

Enable HTTP2 (which is disabled by default):

server {
    # [...]
    listen [::]:443 ssl http2;
}

Tweak /etc/nginx/nginx.conf and add gzip compression for ActivityPub responses:

http {
    # [...]
    gzip_types text/plain text/css application/json application/javascript application/activity+json application/octet-stream;
}

YunoHost edition

YunoHost support is a work in progress.