From 9d6a3ea3cf1c755939efa5b3af059ce233b1c7e8 Mon Sep 17 00:00:00 2001 From: Thomas Sileo Date: Thu, 28 Jul 2022 20:38:54 +0200 Subject: [PATCH] Update docs --- Makefile | 4 ++++ docs/install.md | 40 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 27df1d4..6bc9099 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,10 @@ SHELL := /bin/bash PWD=$(shell pwd) +.PHONY: build +build: + docker build -t microblogpub/microblogpub . + .PHONY: config config: # Run and remove instantly diff --git a/docs/install.md b/docs/install.md index ed9ee48..e1bd495 100644 --- a/docs/install.md +++ b/docs/install.md @@ -4,7 +4,41 @@ ## Docker edition -TODO +Assuming Docker and [Docker Compose](https://docs.docker.com/compose/install/) are already installed. + +For now, there's no image published on Docker Hub. + +Clone the repository. + +```bash +git clone https://git.sr.ht/~tsileo/microblog.pub your-domain.tld +``` + +Build the Docker image. + +```bash +make build +``` + +Run the configuration wizard. + +```bash +make config +``` + +Build static assets. + +```bash +make update +``` + +Start the app with Docker Compose, it will listen on port 8000 by default. + +```bash +docker compose up -d +``` + +Setup a reverse proxy (see the [Reverse Proxy section](/installing.html#reverse-proxy)). ## Python developer edition @@ -46,6 +80,10 @@ 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). + +## Reverse proxy + You will also want to setup a reverse proxy like Nginx, see [uvicorn documentation](https://www.uvicorn.org/deployment/#running-behind-nginx): ```nginx