Browse Source

Update readme and add new diagram

dev
David Ludwig 4 years ago
parent
commit
f3c599676d
3 changed files with 12 additions and 4 deletions
  1. +11
    -4
      README.md
  2. BIN
      diagrams/architecture.png
  3. +1
    -0
      diagrams/diagrams.drawio

+ 11
- 4
README.md View File

@ -4,7 +4,14 @@ Autoplex is an all-in-one media management utility for Plex.
## Setup
1. Clone this repository with all submodules
2. Configure `.env` files inside each submodule
3. Execute the `setup.sh` script to generate secrets for the containers
4. Deploy using `docker-compose`
1. Clone this repository
2. Configure a `docker-compose.env.yml` file to mount filesystems to the storage manager and torrent client.
3. Generate and configure Docker `secrets` by running `generate_secrets.sh`
4. Load the Docker Buildkit environment by running `source ./env.sh`
5. Deploy using `docker-compose`
## Development
### Architecture
![Architecture Overview](diagrams/architecture.png)

BIN
diagrams/architecture.png View File

Before After
Width: 1671  |  Height: 841  |  Size: 141 KiB

+ 1
- 0
diagrams/diagrams.drawio View File

@ -0,0 +1 @@
<mxfile host="app.diagrams.net" modified="2021-06-25T16:55:14.477Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.105 Safari/537.36" etag="H9R-f9ZGqernv-JFHs6f" version="14.8.1" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">7V1de9o2FP41uRyPLfmLy5C0Wba0zZY27a72KKCAW4OYLRLYr59sS2BbAgzYlkjXXBQLY2Od9311ztGRuIBX0+VNjOaTD2SEowtgjZYX8PoCAGj3ffZf2rLKW2zou3nLOA5HvG3T8BD+i3mjxVsX4QgnpRMpIREN5+XGIZnN8JCW2lAck9fyac8kKt91jsZYangYokhu/RqO6CRvDYC/af8Vh+OJuLPt9fN3pkiczJ8kmaAReS00wXcX8ComhOavpssrHKW9J/rl6+3qa3T3w7v57Y/kH/Rl8Pvnj4+/5Bd7f8hH1o8Q4xk9+tJ/D8aPKxB9+97//VP0OJmO55d3/CPWC4oWvL+uw2RI4hFr/JLgmD85XYnuJAsahTN8tbaWdQEHz2RGr0hE4uwcyP7ep99hMI7RKMSb92Zkxi4zSGhMfmDVB57DKCq0P2f/WPsIJRM84nd7wTENmYHv0BOO7kkS0pDM2HtPhFIyLZxwGYXj9A1K5qwV8aMh+0LsweBgQqcRO7b5A3Do2kAc84dOb4mSef60z+Ey/R4DhoV5+uZ0OU5500OvidOLcUIW8RDfDtPvM2CH+avyWYsku3tNm3Lbp4+ElwVEcxvfYDLFNF6xU/i7v3gONypnrCvw+7qBv8ebJgXkizbECTdeX3oDKvaC4+oAjLlAQhEeMY7yQw6KmCxmo7WNvy+mc3ECioeihZvIYcckphMyJjOGA5LaN7Pjd0zpip+FFpSUrcx6Ol5943fIDv5KD3quOLxeFt+8XvGjhKKYXqZalKIsIsMfovF9GImLH2bPHCg7Ok1IJYrHmO7qXH5i2qM74RHjCNHwpayKzdva/d/W7dkaGmVrIU2bsePy/pY13CCKX9FKAkLZ6q+TkOKHOcp65pXJY9l+jcsjV0MnkNXQBi3J4d3t8CbCf1gvD4Pl8sv8Cj33/25BDq1mKQIO4sgwQkkSDhUswcuQfiu8LhCQHW2unR6ISysB3iDVgEw1pZGcvk5mAZlZCwZWYD3g+CVkD2gktYDTIbWU/eb0D6dWg8TxGxlc1LQBu3kjC0TDxIE1xyhg1BDlWocDolN3pE3I+HWktnOAmOWvQklpN/HvgAX2ZgmtCPFAjRCvY+X1tSpvIyzaT3wTeOacJc+c4PzxcdTArMn6Zg3DjqSyX/ETd2cVOUYzRdbRLrLQlrqqDRK1kAJpDof8o/ckZPctGMstGwu6FSPkzOIfK2bJq1eC3p4r5dyTrpRZdP1EJxgZdqyUG3H8q6SN5uTH3Jqi5xgleu4W0ftyeyaCB7ULnr21D/+fmsIX5z81pUJYp1NT4GxH1P2ZTqumagqSGSKb4nsXOH+bsmKG5WicXS6cJ7gA+mFEFqP9GsqwTxHTirhtTV1PNwjE2zU1NWgN8s65Qn4vkq2OnM2qUd2azmZTLiKQs1bNU6QzSriWq5sSXieU2OZyr98zyOUGjQ8Kai45lWirOtK3HGwB2cE8HyY5Vrnv7Lr+emtEcvTGrkYSye+GSB7QSyT/jInkeqYRCQRSd34mcfbcwIvY3QdPLP71xumr+5i8hCMcJ+Z3dHXo9z3dHQ2PmCA2wxvuPKXqiuqKk1Oq0pXaTqkeUZRohpH3z7o3nvOsiQan67R4Nz76m7ahG2i2oTwP+IZSO4721A6UnbBPdJJmyq3L+Tzp9Xo7ullXOsDzK90I5W7sK3rRaS2I6SYnXAxiyjNwvf6+coXs6B7HIXviDOgH1zAU6hbWs34N1TDsr01Q5xbqVD9YaiydKIwuYDYAHrRdP+g7PgxKgJT42nJ2zwE/Bf58ffhTh+Qa8eeB3gZ9XgD14k+egPnAIkzMLvb58SIt2kHx0Nxi9C2hZqfF6colBeCIEsl21n0IDhYJuK+KcS0XdlkrGlorsoWRzdXN1a0hyddYdTD5qV52coT2d7o26IzNre5wvXWR8vTDfcT0DVgf0AyNTS2NlCIfS7e22kdMap8jb9YlyD3L8kry7dj93frNDqoeW9ssdOt6ZDkPdImufURt+lmDpwScWvXrJmDkVN/7NIwcsbLwLS3a9YLzVRc3aCVqgwITYhT0W4vT1PFE42sbDYXkiUDa6wPap7r8W/BRmZF3+t3iAxoTbx5ZrrE/y6QvwFCJj9oKWl2b5tc/NzGvVsu/tcsjENyTnlAMQMe6U8Zg5+RNKLYIU78sTFDMj3c0DSieX04wmh32gkq9naM9pSgrvBkraLcTfL+4bA9xvSM0oHUu19324GQn9LTwpfFtucyElzp6CZiVzgE47XinpwHHPCeyDJzDNlDpJMjocuqwGmS4sOMg9KcWllo7fxigIUCrhkDzcmeHrXk3OhCtiwGo1QERPr92DBwx0eKUOA9tbyfp9TkTjQ8ujl+uhIIe7DZQlNc5ZhUoZxUl6t+by5UXkzxQEqf7phvel9JEs/bNW8FOGdvo0btNq769WjbFdsVaO/tg+ep+qFPHIjVdbdCKGFbWsICqo92cFu56+AKH8z1QrGtE0RNK5DK8dd38KgoZ/mK4n8dPOVLvntYNaPhjnOH3U765ihhF+SDsrs0ukbqu4XcIaanDVYvyAgX1m6iuV1N/N/eNc2Fap2PtLWH1pr4UToRYStlKLWvzTKgOg572xPMxm4i0G9JVylKbSgupa2W7q5lpJ5zf4u5XN+YI/PIl6i74lGa+A9DpWOkYh84Dk1KnJBx0Z6p2ILbOlKfWTJViY53NWHEVhXjWyI7Q7Y8Qbt2F9e2NEDt2MLDucQvbFTTfq0G1V7tc4alO4pnig7a8HEQ97OrVMNhZtn1LAFpFY9f1ZKaMqobEP7AdMweV6hxpc7mWnScoj4GP9x/lYW9Cpk+LRJ84S3RQiTPsVJzl1TyirulP/M8CJ/RNp2sqTr9qb9dO8zVQ4YE8/py28HTbwpHTl3yh25afABAWmOAlGmdbFs8L4RBvXUdIYL99st2RxcDToSzpXxvn7ApqRm+VAr7YVVRQQDE8dEsBTzbDBGcDxDXrBSv77cS3wgIDUC/vhfP58e11tP5AX+zlVujoj4SGz+EQZZvfNzrF3H7mpM0fPWCHm18Lz/31zY+uw3f/AQ==</diagram></mxfile>

Loading…
Cancel
Save