mirror/audiobookshelf.audiobookshelf-web
1
0
Fork 0
mirror of https://github.com/audiobookshelf/audiobookshelf-web.git synced 2025-08-31 06:59:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix and cleanup docs styling

Browse source
This commit is contained in:
advplyr 2022-08-08 18:00:25 -05:00
parent 28da63ca0c
commit 1896f9ee26
5 changed files with 78 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

43
components/docs/install/DockerCompose.vue
View file

@ -1,14 +1,14 @@
<template> <template>
<div id="install-docker-compose" class="py-10 md:py-20"> <div id="install-docker-compose" class="py-10 md:py-20">
<h1 class="text-xl md:text-3xl mb-4 md:-ml-8"> <h1 class="text-xl md:text-3xl mb-4 md:-ml-8">
<nuxt-link to="#install-docker-compose"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link <nuxt-link to="#install-docker-compose"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
>Docker-compose >Docker-compose
</h1> </h1>
<p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7</p> <p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7</p>
<pre> <pre>
<code class="language-bash">version: "3.7" <code class="language-bash">version: "3.7"
services: services:
audiobookshelf: audiobookshelf:
image: ghcr.io/advplyr/audiobookshelf:latest image: ghcr.io/advplyr/audiobookshelf:latest
@ -18,23 +18,20 @@ services:
ports: ports:
- 13378:80 - 13378:80
volumes: volumes:
- &#60;/path/to/your/audiobooks&#62;:/audiobooks - &lt;/path/to/config>:/audiobooks
- &#60;/path/to/your/podcasts&#62;:/podcasts - &lt;/path/to/config>:/podcasts
- &#60;/path/to/config&#62;:/config - &lt;/path/to/config>:/config
- &#60;/path/to/metadata&#62;:/metadata - &lt;/path/to/config>:/metadata</code>
</pre>
</code> <p class="text-error">Note: Remember to change the path to your actual directory and remove the &#60;&#62; symbols</p>
</pre> <p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother.</p>
<p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother.</p> <p class="mt-2 mb-1 font-semibold text-lg">Volume mappings</p>
<!-- <p class="text-warning py-1">Unraid users: it is recommended that you map <span class="font-mono">/config</span> and <span class="font-mono">/metadata</span> to <span class="font-mono">/mnt/user/appdata/audiobookshelf/config</span> and <span class="font-mono">/mnt/user/appdata/audiobookshelf/metadata</span> respectively.</p> --> <p>• &nbsp;<span class="font-mono">/config</span> will contain the database (users/books/libraries/settings)</p>
<p>• &nbsp;<span class="font-mono">/metadata</span> will contain cache, streams, covers, downloads, backups and logs</p>
<p>• &nbsp;Map any other directories you want to use for your book and podcast collections (ebooks supported as experimental)</p>
<p class="mt-2 mb-1 font-semibold text-lg">Volume mappings</p> </div>
<p>• &nbsp;<span class="font-mono">/config</span> will contain the database (users/books/libraries/settings)</p>
<p>• &nbsp;<span class="font-mono">/metadata</span> will contain cache, streams, covers, downloads, backups and logs</p>
<p>• &nbsp;Map any other directories you want to use for your book and podcast collections (ebooks supported as experimental)</p>
</div>
</template> </template>
<script> <script>

57
components/docs/install/docker.vue
View file

@ -1,37 +1,38 @@
<template> <template>
<div id="install-docker" class="py-10 md:py-20"> <div id="install-docker" class="py-10 md:py-20">
<h1 class="text-xl md:text-3xl mb-4 md:-ml-8"> <h1 class="text-xl md:text-3xl mb-4 md:-ml-8">
<nuxt-link to="#install-docker"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link <nuxt-link to="#install-docker"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
>Docker >Docker
</h1> </h1>
<p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7</p> <p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7</p>
<pre> <pre>
<code class="language-bash"> <code class="language-bash">
docker pull ghcr.io/advplyr/audiobookshelf docker pull ghcr.io/advplyr/audiobookshelf
docker run -d \
-e AUDIOBOOKSHELF_UID=99 \
-e AUDIOBOOKSHELF_GID=100 \
-p 13378:80 \
-v &lt;/path/to/config>:/config \
-v &lt;/path/to/metadata>:/metadata \
-v &lt;/path/to/audiobooks>:/audiobooks \
-v &lt;/path/to/podcasts>:/podcasts \
--name audiobookshelf \
--rm ghcr.io/advplyr/audiobookshelf</code>
</pre>
<p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother.</p> docker run -d \
<!-- <p class="text-warning py-1">Unraid users: it is recommended that you map <span class="font-mono">/config</span> and <span class="font-mono">/metadata</span> to <span class="font-mono">/mnt/user/appdata/audiobookshelf/config</span> and <span class="font-mono">/mnt/user/appdata/audiobookshelf/metadata</span> respectively.</p> --> -e AUDIOBOOKSHELF_UID=99 \
-e AUDIOBOOKSHELF_GID=100 \
-p 13378:80 \
-v &lt;/path/to/config>:/config \
-v &lt;/path/to/metadata>:/metadata \
-v &lt;/path/to/audiobooks>:/audiobooks \
-v &lt;/path/to/podcasts>:/podcasts \
--name audiobookshelf \
--rm ghcr.io/advplyr/audiobookshelf</code>
</pre>
<p class="mt-2 mb-1 font-semibold text-lg">Volume mappings</p> <p class="text-error">Note: Remember to change the path to your actual directory and remove the &#60;&#62; symbols</p>
<p>• &nbsp;<span class="font-mono">/config</span> will contain the database (users/books/libraries/settings)</p> <p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother</p>
<p>• &nbsp;<span class="font-mono">/metadata</span> will contain cache, streams, covers, downloads, backups and logs</p> <p class="text-error">Note: Windows users will need to remove the \ and run this as a single line</p>
<p>• &nbsp;Map any other directories you want to use for your book and podcast collections (ebooks supported as experimental)</p>
</div> <p class="mt-2 mb-1 font-semibold text-lg">Volume mappings</p>
<p>• &nbsp;<span class="font-mono">/config</span> will contain the database (users/books/libraries/settings)</p>
<p>• &nbsp;<span class="font-mono">/metadata</span> will contain cache, streams, covers, downloads, backups and logs</p>
<p>• &nbsp;Map any other directories you want to use for your book and podcast collections (ebooks supported as experimental)</p>
</div>
</template> </template>
<script> <script>

28
components/docs/updating/docker.vue
View file

@ -1,21 +1,21 @@
<template> <template>
<div id="updating-docker" class="py-10 md:py-20"> <div id="updating-docker" class="py-10 md:py-20">
<h1 class="text-xl md:text-3xl mb-4 md:-ml-8"> <h1 class="text-xl md:text-3xl mb-4 md:-ml-8">
<nuxt-link to="#updating-docker"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link <nuxt-link to="#updating-docker"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
>Docker >Docker
</h1> </h1>
<p class="mb-2 text-sm md:text-base">To update your Docker container to the latest version run the following commands</p> <p class="mb-2 text-sm md:text-base">To update your Docker container to the latest version run the following commands</p>
<pre> <pre>
<code class="language-bash">docker stop audiobookshelf <code class="language-bash">docker stop audiobookshelf
docker rm audiobookshelf docker rm audiobookshelf
docker image prune -a docker image prune -a
docker pull ghcr.io/advplyr/audiobookshelf:latest docker pull ghcr.io/advplyr/audiobookshelf:latest
docker start audiobookshelf</code> # then use initial run command again</code>
</pre> </pre>
</div> </div>
</template> </template>
<script> <script>

6
pages/docs.vue
View file

@ -107,7 +107,11 @@ export default {
}, },
computed: {}, computed: {},
methods: {}, methods: {},
mounted() {} mounted() {
if (typeof Prism !== undefined) {
Prism.highlightAll()
}
}
} }
</script> </script>

22
pages/install.vue
View file

@ -44,7 +44,7 @@ docker run -d \
<p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7. Also available in Unraid Community Apps.</p> <p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7. Also available in Unraid Community Apps.</p>
<pre> <pre>
<code class="language-bash">version: "3.7" <code class="language-bash">version: "3.7"
services: services:
audiobookshelf: audiobookshelf:
image: ghcr.io/advplyr/audiobookshelf:latest image: ghcr.io/advplyr/audiobookshelf:latest
@ -57,10 +57,8 @@ services:
- &lt;/path/to/config>:/audiobooks - &lt;/path/to/config>:/audiobooks
- &lt;/path/to/config>:/podcasts - &lt;/path/to/config>:/podcasts
- &lt;/path/to/config>:/config - &lt;/path/to/config>:/config
- &lt;/path/to/config>:/metadata - &lt;/path/to/config>:/metadata</code>
</pre>
</code>
</pre>
<p class="text-error">Note: Remember to change the path to your actual directory and remove the &#60;&#62; symbols </p> <p class="text-error">Note: Remember to change the path to your actual directory and remove the &#60;&#62; symbols </p>
<p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother.</p> <p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother.</p>
@ -82,13 +80,13 @@ services:
<span class="text-error">Note: Only for amd64 architecture</span> <span class="text-error">Note: Only for amd64 architecture</span>
<p class="mb-2 mt-1 text-sm md:text-base">Will use config file <span class="bg-white bg-opacity-10 text-gray-100 rounded-md px-1 py-0.5 font-mono">/etc/default/audiobookshelf</span> if exists or create the following default config:</p> <p class="mb-2 mt-1 text-sm md:text-base">Will use config file <span class="bg-white bg-opacity-10 text-gray-100 rounded-md px-1 py-0.5 font-mono">/etc/default/audiobookshelf</span> if exists or create the following default config:</p>
<pre> <pre>
<code class="language-bash"> METADATA_PATH="/usr/share/audiobookshelf/metadata" <code class="language-bash">METADATA_PATH="/usr/share/audiobookshelf/metadata"
CONFIG_PATH="/usr/share/audiobookshelf/config" CONFIG_PATH="/usr/share/audiobookshelf/config"
FFMPEG_PATH="/usr/lib/audiobookshelf-ffmpeg/ffmpeg" FFMPEG_PATH="/usr/lib/audiobookshelf-ffmpeg/ffmpeg"
FFPROBE_PATH="/usr/lib/audiobookshelf-ffmpeg/ffprobe" FFPROBE_PATH="/usr/lib/audiobookshelf-ffmpeg/ffprobe"
PORT=7331</code> PORT=7331</code>
</pre> </pre>
<br /> <br />