microblog.pub/docs/install.md

191 lines
4.2 KiB
Markdown
Raw Normal View History

2022-07-05 19:35:39 +00:00
# Installing
[TOC]
## Docker edition
2022-07-28 18:38:54 +00:00
Assuming Docker and [Docker Compose](https://docs.docker.com/compose/install/) are already installed.
2022-07-30 07:31:04 +00:00
For now, there's no image published on Docker Hub, this means you will have to build the image locally.
2022-07-28 18:38:54 +00:00
2022-07-30 07:31:04 +00:00
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.
2022-07-28 18:38:54 +00:00
```bash
git clone https://git.sr.ht/~tsileo/microblog.pub your-domain.tld
```
2022-07-30 07:31:04 +00:00
Build the Docker image locally.
2022-07-28 18:38:54 +00:00
```bash
make build
```
Run the configuration wizard.
```bash
make config
```
2022-07-30 07:31:04 +00:00
Update `data/profile.toml` and add this line in order to process headers from the reverse proxy:
2022-07-30 06:52:04 +00:00
```toml
trusted_hosts = ["*"]
```
2022-07-28 18:38:54 +00:00
Start the app with Docker Compose, it will listen on port 8000 by default.
2022-07-30 07:31:04 +00:00
The port can be tweaked in the `docker-compose.yml` file.
2022-07-28 18:38:54 +00:00
```bash
docker compose up -d
```
Setup a reverse proxy (see the [Reverse Proxy section](/installing.html#reverse-proxy)).
2022-07-05 19:35:39 +00:00
2022-07-30 07:31:04 +00:00
### Updating
To update microblogpub, pull the latest changes, rebuild the Docker image and restart the process with `docker compose`.
```bash
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](https://docs.docker.com/config/pruning/#prune-images) from time to time:
```bash
docker image prune -a --filter "until=24h"
```
2022-07-05 07:15:45 +00:00
## Python developer edition
2022-07-05 19:35:39 +00:00
Assuming you have a working **Python 3.10+** environment.
2022-07-05 07:15:45 +00:00
Setup [Poetry](https://python-poetry.org/docs/master/#installing-with-the-official-installer).
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
Clone the repository.
```bash
git clone https://git.sr.ht/~tsileo/microblog.pub testing.microblog.pub
```
Install deps.
```bash
poetry install
```
Setup config.
```bash
poetry run inv configuration-wizard
```
Grab your virtualenv path.
```bash
poetry env info
```
Run the two processes with supervisord.
```bash
VENV_DIR=/home/ubuntu/.cache/pypoetry/virtualenvs/microblogpub-chx-y1oE-py3.10 poetry run supervisord -c misc/supervisord.conf -n
```
2022-07-28 18:38:54 +00:00
Setup a reverse proxy (see the next section).
2022-07-30 07:31:04 +00:00
### Updating
2022-08-30 03:30:25 +00:00
To update microblogpub locally, pull the remote changes and run the `update` task to regenerate the CSS and run any DB migrations.
2022-07-30 07:31:04 +00:00
```bash
git pull
poetry run inv update
```
2022-07-28 18:38:54 +00:00
## Reverse proxy
2022-07-30 07:31:04 +00:00
You will also want to setup a reverse proxy like NGINX, see [uvicorn documentation](https://www.uvicorn.org/deployment/#running-behind-nginx):
If you don't have a reverse proxy setup yet, [NGINX + certbot](https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/) is recommended.
2022-07-05 07:15:45 +00:00
```nginx
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;
}
# [...]
}
2022-08-30 03:30:25 +00:00
# This should be outside the `server` block
2022-08-29 17:28:54 +00:00
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
2022-07-05 07:15:45 +00:00
```
2022-07-30 07:31:04 +00:00
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.
```nginx
server {
# [...]
location / {
# [...]
}
location /static {
# path for static files
rewrite ^/static/(.*) /$1 break;
root /path/to/your-domain.tld/app/static/;
2022-08-26 18:25:55 +00:00
expires 1y;
2022-07-30 07:31:04 +00:00
}
# [...]
}
```
2022-08-24 05:52:46 +00:00
2022-08-26 18:18:59 +00:00
### NGINX config tips
Enable HTTP2 (which is disabled by default):
```nginx
server {
# [...]
listen [::]:443 ssl http2;
}
```
Tweak `/etc/nginx/nginx.conf` and add gzip compression for ActivityPub responses:
```nginx
http {
# [...]
gzip_types text/plain text/css application/json application/javascript application/activity+json application/octet-stream;
}
```
2022-08-24 05:52:46 +00:00
## YunoHost edition
[YunoHost](https://yunohost.org/) support is a work in progress.