Browse Source

Updated README.md.

master
treyzania 4 years ago
parent
commit
ae2db6932b
1 changed files with 43 additions and 1 deletions
  1. 43
    1
      README.md

+ 43
- 1
README.md View File

@@ -1,3 +1,45 @@
# yarrbox

Configuration for docker-compose for my magic machine of goodies.
Configuration tool for docker-compose for my magic machine of goodies.

You need Python 3 installed, but you don't need any extra libraries. This also
assumes that you're using a recent version of Docker and Docker-Compose.

This might work on macOS Docker, probably not Windows, but you can try I guess.
I'm not sure why you would want to run this on anything other than a big ol'
Linux server though.

## Initial Setup

First, generate your personal configuration.

```sh
./yarrbox.py init
```

(after this step isn't implemented yet)

Next, generate the `docker-compose.yml` file.

```sh
./yarrbox.py generate
```

Then, you can launch everything, make sure to detach from them so you're not
spammed with the output of all these programs.

```sh
sudo docker-compose up -d
```

## Extras

You can edit the config with `./yarrbox.py edit`, you'll need to regenerate the
config after. And then all rules of thumb for editing Compose configs applies
after that. You might want to `down` the containers *just in case*.

## Future work

I'm more than welcome to accept patches to support Kodi. I'm planning on
migrating to that in the future. The config tool isn't as advanced to support
different/multiple distribution frontends so you'll have to do that yourself.

Loading…
Cancel
Save