Add README.org

This commit is contained in:
TakeV 2024-02-02 20:05:40 -05:00
parent 1b3774a25c
commit 486ac1f490
Signed by: TakeV
GPG key ID: A64F41345C7400AF

45
README.org Normal file
View file

@ -0,0 +1,45 @@
#+#+title: Solarpunk Mastodon
The solarpunk.moe mastodon configuration and customizations.
* Build
Building the project requires a couple of steps.
** Copy files
To build, copy the content of this folder to a copy of the mastodon source code, then =docker compose build=.
Assuming that your local mastodon checkout is located at =~/src/mastodon=, you can run the following from this project folder:
#+begin_src sh
SOLARPUNK_REPO=$PWD
MASTODON_REPO=$HOME/src/mastodon
cp -r $SOLARPUNK_REPO/* $MASTODON_REPO/
cp -r $SOLARPUNK_REPO/.env.production $MASTODON_REPO/
#+end_src
Should you have your mastodon checkout in a different location, set =MASTODON_REPO= to that location.
** Build docker images
After copying the files, we can build the docker images with:
#+begin_src sh
cd $MASTODON_REPO
docker compose build
#+end_src
* WIP Running mastodon
To run the instance, follow these steps:
*Going to need vv to fill this part out.*
** TODO Set up external networks
** TODO Set up reverse proxy
** TODO Set up cert-bot
** TODO Run containers