forked from forks/microblog.pub
Update docs
This commit is contained in:
parent
32763a3368
commit
9d6a3ea3cf
2 changed files with 43 additions and 1 deletions
4
Makefile
4
Makefile
|
@ -1,6 +1,10 @@
|
||||||
SHELL := /bin/bash
|
SHELL := /bin/bash
|
||||||
PWD=$(shell pwd)
|
PWD=$(shell pwd)
|
||||||
|
|
||||||
|
.PHONY: build
|
||||||
|
build:
|
||||||
|
docker build -t microblogpub/microblogpub .
|
||||||
|
|
||||||
.PHONY: config
|
.PHONY: config
|
||||||
config:
|
config:
|
||||||
# Run and remove instantly
|
# Run and remove instantly
|
||||||
|
|
|
@ -4,7 +4,41 @@
|
||||||
|
|
||||||
## Docker edition
|
## 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
|
## 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
|
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):
|
You will also want to setup a reverse proxy like Nginx, see [uvicorn documentation](https://www.uvicorn.org/deployment/#running-behind-nginx):
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
|
|
Loading…
Reference in a new issue