Add caddy docs
This commit is contained in:
parent
f1ddda7580
commit
b28ebdcfb0
3 changed files with 52 additions and 19 deletions
|
@ -38,7 +38,7 @@ services:
|
||||||
# You can prefix the left side with an ip.
|
# You can prefix the left side with an ip.
|
||||||
|
|
||||||
# Webserver (for reverse-proxies outside of docker)
|
# Webserver (for reverse-proxies outside of docker)
|
||||||
# If you use a dockerized proxy (see README), you can leave this commented
|
# If you use a dockerized proxy, you can leave this commented
|
||||||
# and use a container link instead.
|
# and use a container link instead.
|
||||||
"127.0.0.1:4000:4000",
|
"127.0.0.1:4000:4000",
|
||||||
]
|
]
|
||||||
|
@ -46,14 +46,16 @@ services:
|
||||||
- .:/opt/akkoma
|
- .:/opt/akkoma
|
||||||
|
|
||||||
# Uncomment the following if you want to use a reverse proxy
|
# Uncomment the following if you want to use a reverse proxy
|
||||||
proxy:
|
#proxy:
|
||||||
image: caddy:2-alpine
|
# image: caddy:2-alpine
|
||||||
restart: unless-stopped
|
# restart: unless-stopped
|
||||||
links:
|
# links:
|
||||||
- akkoma
|
# - akkoma
|
||||||
ports: [
|
# ports: [
|
||||||
"443:443",
|
# "443:443",
|
||||||
"80:80"
|
# "80:80"
|
||||||
]
|
# ]
|
||||||
volumes:
|
# volumes:
|
||||||
- ./docker-resources/Caddyfile:/etc/caddy/Caddyfile
|
# - ./docker-resources/Caddyfile:/etc/caddy/Caddyfile
|
||||||
|
# - ./caddy-data:/data
|
||||||
|
# - ./caddy-config:/config
|
|
@ -1,6 +1,4 @@
|
||||||
# Installing in docker
|
# Installing in Docker
|
||||||
|
|
||||||
{! installation/otp_vs_from_source_source.include !}
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -22,6 +20,7 @@ releases.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cp docker-resources/env.example .env
|
cp docker-resources/env.example .env
|
||||||
|
echo "DOCKER_USER=$(id -u):$(id -g)" >> .env
|
||||||
```
|
```
|
||||||
|
|
||||||
This probably won't need to be changed, it's only there to set basic environment
|
This probably won't need to be changed, it's only there to set basic environment
|
||||||
|
@ -43,15 +42,17 @@ in our compose environment.
|
||||||
### Generating your instance
|
### Generating your instance
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
mkdir pgdata
|
||||||
|
# if you want to use caddy
|
||||||
|
mkdir caddy-data
|
||||||
|
mkdir caddy-config
|
||||||
./docker-resources/manage.sh mix deps.get
|
./docker-resources/manage.sh mix deps.get
|
||||||
./docker-resources/manage.sh mix compile
|
./docker-resources/manage.sh mix compile
|
||||||
./docker-resources/manage.sh mix pleroma.instance gen
|
./docker-resources/manage.sh mix pleroma.instance gen
|
||||||
```
|
```
|
||||||
|
|
||||||
This will ask you a few questions - the defaults are fine for most things,
|
This will ask you a few questions - the defaults are fine for most things,
|
||||||
the database hostname is `db`, and you will want to set the ip to `0.0.0.0`
|
the database hostname is `db`, and you will want to set the ip to `0.0.0.0`.
|
||||||
if you want to access the instance from outside the container (i.e you're using
|
|
||||||
a reverse proxy on the host)
|
|
||||||
|
|
||||||
Now we'll want to copy over the config it just created
|
Now we'll want to copy over the config it just created
|
||||||
|
|
||||||
|
@ -125,9 +126,33 @@ Then edit the TLD in your caddyfile to the domain you're serving on.
|
||||||
Uncomment the `caddy` section in the docker-compose file,
|
Uncomment the `caddy` section in the docker-compose file,
|
||||||
then run `docker-compose up -d` again.
|
then run `docker-compose up -d` again.
|
||||||
|
|
||||||
```bash
|
#### Running a reverse proxy on the host
|
||||||
|
|
||||||
|
If you want, you can also run the reverse proxy on the host. This is a bit more complex, but it's also more flexible.
|
||||||
|
|
||||||
|
Follow the guides for source install for your distribution of choice, or adapt
|
||||||
|
as needed. Your standard setup can be found in the [Debian Guide](../debian_based_en/#nginx)
|
||||||
|
|
||||||
|
### You're done!
|
||||||
|
|
||||||
|
All that's left is to set up your frontends.
|
||||||
|
|
||||||
|
The standard from-source commands will apply to you, just make sure you
|
||||||
|
prefix them with `./docker-resources/manage.sh`!
|
||||||
|
|
||||||
{! installation/frontends.include !}
|
{! installation/frontends.include !}
|
||||||
|
|
||||||
|
### Updating Docker Installs
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
./docker-resources/build.sh
|
||||||
|
./docker-resources/manage.sh mix deps.get
|
||||||
|
./docker-resources/manage.sh mix compile
|
||||||
|
./docker-resources/manage.sh mix ecto.migrate
|
||||||
|
docker-compose restart akkoma
|
||||||
|
```
|
||||||
|
|
||||||
#### Further reading
|
#### Further reading
|
||||||
|
|
||||||
{! installation/further_reading.include !}
|
{! installation/further_reading.include !}
|
||||||
|
|
|
@ -21,5 +21,11 @@ For most installations, the following will suffice:
|
||||||
mix pleroma.frontend install admin-fe --ref stable
|
mix pleroma.frontend install admin-fe --ref stable
|
||||||
```
|
```
|
||||||
|
|
||||||
|
=== "Docker"
|
||||||
|
```sh
|
||||||
|
./docker-resources/manage.sh mix pleroma.frontend install pleroma-fe --ref stable
|
||||||
|
./docker-resources/manage.sh mix pleroma.frontend install admin-fe --ref stable
|
||||||
|
```
|
||||||
|
|
||||||
For more customised installations, refer to [Frontend Management](../../configuration/frontend_management)
|
For more customised installations, refer to [Frontend Management](../../configuration/frontend_management)
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue