chore: clean up unneeded bootstrap
This commit is contained in:
parent
fdd73a56db
commit
2b246f7e38
5 changed files with 26 additions and 37 deletions
|
@ -7,3 +7,7 @@
|
|||
|[Plex](./plex)|Plex media server|
|
||||
|[Deluge](./deluge)|Deluge Web service|
|
||||
|[Kong](./kong)|Kong API Gateway|
|
||||
|
||||
## Getting started
|
||||
|
||||
Use `. script/bootstrap` to set up the Python venv required to develop.
|
||||
|
|
17
deluge/README.md
Normal file
17
deluge/README.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
# Deluge
|
||||
|
||||
[Deluge](https://deluge-torrent.org/) is a torrent web server.
|
||||
|
||||
## Setup
|
||||
|
||||
Make sure to have `APP_STORAGE_ROOT` and `DATA_STORAGE_ROOT` set up as environment variables on the host machine when
|
||||
starting the service; this will determine where downloaded content and configuration goes.
|
||||
|
||||
## Usage
|
||||
|
||||
### Starting/stopping
|
||||
|
||||
`inv deluge.start` and `inv deluge.stop` can be used to start and stop the service.
|
||||
|
||||
The data volume can be accessed as `/complete` and can be used to automove content from the Deluge app data to its final
|
||||
repository when a download completes.
|
|
@ -1,3 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
mkdir ./{config,downloads}
|
|
@ -1,18 +1,10 @@
|
|||
# Plex
|
||||
|
||||
[Plex](https://www.plex.tv/) is a media server.
|
||||
|
||||
## Setup
|
||||
|
||||
*Requires `docker-compose`*
|
||||
Make sure that `pass` is installed on the host and that the `plex-claim` secret is set up to the claim ID provided by
|
||||
Plex.
|
||||
|
||||
Run `. script/bootstrap` to check that `docker-compose` is available and to create the required directory structure.
|
||||
|
||||
Run `. script/start` to start the service.
|
||||
|
||||
### First setup only
|
||||
|
||||
Make sure to create a `plex.env` file containing:
|
||||
|
||||
|Environment variable|Description|
|
||||
|---|---|
|
||||
|`ADVERTISE_IP`|Full address and port of the network entry point to advertise for Plex.|
|
||||
|`PLEX_CLAIM`|Claim ID required to link the server to a Plex account|
|
||||
`DATA_STORAGE_ROOT` and `APP_STORAGE_ROOT` should be set as environment variables in the host as well.
|
||||
|
|
|
@ -1,21 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Bootstrap for Plex
|
||||
#
|
||||
# Verifies that docker-compose is available and that the required directories
|
||||
# are present.
|
||||
|
||||
if ! [ -x "$(command -v docker-compose)" ]; then
|
||||
echo "👎 docker-compose isn't available but is required."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ docker-compose $(docker-compose version --short) found."
|
||||
|
||||
# Required directory structure, these will be mapped to locations in the Plex
|
||||
# container.
|
||||
|
||||
mkdir ./{media,database,transcode} -vp
|
||||
|
||||
echo "✅ directory structure ready"
|
||||
echo "✨ Good to go ✨"
|
Reference in a new issue