diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index f8763bda..410a71d1 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -13,7 +13,7 @@ jobs: # Smoketest # - name: Build the wiki - # run: docker-compose up -d + # run: docker compose up -d # - name: Test container comes up and listens on port 8000 # run: docker run --network container:wiki_wiki_1 curlimages/curl -s --retry 10 --retry-connrefused http://localhost:8000/ @@ -33,7 +33,7 @@ jobs: USERNAME: ${{ secrets.WIKI_DEPLOY_USER }} PORT: ${{ secrets.WIKI_SSH_PORT }} KEY: ${{ secrets.SSHKEY }} - script: cd ${{ secrets.PROJECT_PATH }} && docker-compose run wiki build + script: cd ${{ secrets.PROJECT_PATH }} && docker compose run wiki build # Deploy - name: Deploy new image and cleanup @@ -43,4 +43,4 @@ jobs: USERNAME: ${{ secrets.WIKI_DEPLOY_USER }} PORT: ${{ secrets.WIKI_SSH_PORT }} KEY: ${{ secrets.SSHKEY }} - script: docker-compose -f ~/docker-compose.yml up -d && docker image prune -af \ No newline at end of file + script: docker compose -f ~/docker compose.yml up -d && docker image prune -af \ No newline at end of file diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 3685d7be..c947ed87 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,6 +1,6 @@ name: Test -on: [pull_request, push] +on: [pull_request, push, workflow_dispatch] jobs: build: @@ -10,10 +10,10 @@ jobs: - uses: actions/checkout@v1 - name: Build containers - run: docker-compose build + run: docker compose build - name: Build site - run: docker-compose run wiki build --verbose --strict + run: docker compose run wiki build --verbose --strict - name: Build production container run: docker build -f prod/Dockerfile . diff --git a/docs/self-hosted-apps/audiobookshelf.md b/docs/self-hosted-apps/audiobookshelf.md new file mode 100644 index 00000000..b0c6d890 --- /dev/null +++ b/docs/self-hosted-apps/audiobookshelf.md @@ -0,0 +1,73 @@ +# Audiobookshelf + +!!!attention "Make sure to read the official docs" + This guide will be focusing on using docker compose. + + View Audiobookshelf's offical documentation [here](https://www.audiobookshelf.org/docs) for + alternative installation methods. + +## What is Audiobookshelf? + +Audiobookshelf is an open-source self-hosted media server for your audiobooks and podcasts. + +![Audiobookshelf Library](./img/audiobookshelf.png) + +## Features + +- Companion android and iOS app w/ offline listening (in beta) +- Multi-user support w/ custom permissions +- Keeps progress per user and syncs across devices +- Lookup and apply metadata and cover art from several providers +- Audiobook chapter editor w/ chapter lookup +- Audiobook tools: Embed metadata in audio files & merge multiple audio files to a single m4b +- Search and add podcasts to download episodes w/ auto-download +- Open RSS feeds for audiobooks and podcast episodes +- Backups with automated backup scheduling +- Basic ebook support and ereader (epub, pdf, cbr, cbz) + send to device (i.e. Kindle) +- And much more... + +## Requirements + +- [Docker](https://docs.docker.com/engine/install/) +- [Docker-compose](https://docs.docker.com/compose/install/) + +## Getting Started + +Here is an example docker-compose.yml to start with. + +``` +services: + audiobookshelf: + # If you want to use a specific version, replace "latest" with the version you want. + # Example: ghcr.io/advplyr/audiobookshelf:2.18.0 + image: ghcr.io/advplyr/audiobookshelf:latest + ports: + - 13378:80 + volumes: + # Remember to change the path to your actual directory and remove the <> symbols. + - :/audiobooks + - :/podcasts + - :/config + - :/metadata + environment: + - TZ=America/Toronto +``` + +## Start Your Container! +Once your docker-compose.yml is configured to you liking. You can run the command below to start the container. + +``` +docker compose up -d +``` + +Congrats! You can now access your Audiobookshelf instance at + +## Updating + +To update your Audiobookshelf instance, it's as easy as running the following commands. + +``` +docker compose pull +docker compose down +docker compose up -d +``` \ No newline at end of file diff --git a/docs/self-hosted-apps/img/audiobookshelf.png b/docs/self-hosted-apps/img/audiobookshelf.png new file mode 100644 index 00000000..677c0026 Binary files /dev/null and b/docs/self-hosted-apps/img/audiobookshelf.png differ