Add wip readme to repo

This commit is contained in:
ICScaryThings 2022-05-21 20:25:18 -04:00
parent 8b9aca9a83
commit 2e137dd63d

26
README.md Normal file
View file

@ -0,0 +1,26 @@
Containerized Treebird FE Build
========================================
This git repo contains the files needed to builder a docker containerized setup
of nekobit's C FCGI based Treebird Front End for Pleroma or other Mastodon compatibles.
## How to build the container image
The build is divided into two parts to allow you to make custom configuration changes.
Run the following to prepare the container build configuration.
./configure_build.sh instance_domain treebird_domain [treebird_fcgi_port (optional)]
options:
- `instance_domain`: domain of the instance for Treebird FE to connect to (ex: sleepy.cafe)
- `treebird_domain`: domain you plan serve Treebird on (ex: treebird.mysite.com)
- `treebird_fcgi_port`: internal FCGI port for your http server to communicate with Treebird
*DO NOT* set this unless you have a port conflict (default: 4008)
The script will generate a folder named `configs/` containing configuration files you
can edit further as needed before starting the build. Once ready, run the following:
./build_container.sh [image_name (optional)] [container_name (optional)]
NOTE: Unless your user is a member of the `docker` group, you will need root for this!
The build _should_ complete without errors and if you run `docker image ls` you should
see `treebird:latest` (or whatever alt image tag you set in the previous command).