Updating Documentation

components/docs/install/DockerCompose.vue

@@ -0,0 +1,49 @@
+<template>
+    <div id="install-docker-compose" class="py-10 md:py-20">
+        <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
+            >Docker-compose
+        </h1>
+
+        <p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7</p>
+
+        <pre>
+            <code class="language-bash">version: "3.7"
+services:
+  audiobookshelf:
+    image: ghcr.io/advplyr/audiobookshelf:latest
+    environment:
+      - AUDIOBOOKSHELF_UID=99
+      - AUDIOBOOKSHELF_GID=100
+    ports:
+      - 13378:80
+    volumes:
+      - &#60;/path/to/your/audiobooks&#62;:/audiobooks
+      - &#60;/path/to/your/podcasts&#62;:/podcasts
+      - &#60;/path/to/config&#62;:/config
+      - &#60;/path/to/metadata&#62;:/metadata
+            
+            </code>
+        </pre>
+
+        <p class="text-error">Note: Volume mappings should all be separate directories that are not contained in eachother.</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 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>
+
+<script>
+export default {
+  data() {
+    return {}
+  },
+  computed: {},
+  methods: {},
+  mounted() {}
+}
+</script>

components/docs/install/docker.vue

@@ -0,0 +1,46 @@
+<template>
+    <div id="install-docker" class="py-10 md:py-20">
+        <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
+            >Docker
+        </h1>
+
+        <p class="mb-2 text-sm md:text-base">Multi-architecture image for amd64, arm64 and arm/v7</p>
+
+        <pre>
+            <code class="language-bash">
+            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>
+        <!-- <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 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>
+
+<script>
+export default {
+  data() {
+    return {}
+  },
+  computed: {},
+  methods: {},
+  mounted() {}
+}
+</script>

components/docs/updating/docker.vue

@@ -0,0 +1,30 @@
+<template>
+    <div id="updating-docker" class="py-10 md:py-20">
+        <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
+            >Docker
+        </h1>
+
+        <p class="mb-2 text-sm md:text-base">To update your Docker container to the latest version run the following commands</p>
+
+        <pre>
+            <code class="language-bash">docker stop audiobookshelf
+           docker rm audiobookshelf
+           docker image prune -a
+           docker pull ghcr.io/advplyr/audiobookshelf:latest
+           docker start audiobookshelf</code>
+        </pre>
+
+    </div>
+</template>
+
+<script>
+export default {
+  data() {
+    return {}
+  },
+  computed: {},
+  methods: {},
+  mounted() {}
+}
+</script>

layouts/docs.vue

@@ -1,4 +1,5 @@
 <template>
+
   <div class="w-screen h-screen max-w-full max-h-screen text-white bg-gradient overflow-hidden">
     <div id="sidebar" class="hidden md:block fixed top-0 left-0 h-full bg-primary border-r border-white border-opacity-25">
       <div class="flex justify-center items-center py-4 mb-6">
@@ -10,6 +11,14 @@
 
       <sidebar-nav-item v-for="item in introItems" :key="item.hash" :hash="item.hash" :text="item.text" :selected="currentHash === item.hash" />
 
+      <p class="px-4 py-1 text-xs font-bold text-white uppercase mt-6 mb-1">Install</p>
+
+      <sidebar-nav-item v-for="item in installItems" :key="item.hash" :hash="item.hash" :text="item.text" :selected="currentHash === item.hash" />
+
+      <p class="px-4 py-1 text-xs font-bold text-white uppercase mt-6 mb-1">Updating</p>
+
+      <sidebar-nav-item v-for="item in updateItems" :key="item.hash" :hash="item.hash" :text="item.text" :selected="currentHash === item.hash" />
+
       <p class="px-4 py-1 text-xs font-bold text-white uppercase mt-6 mb-1">Books</p>
 
       <sidebar-nav-item v-for="item in bookItems" :key="item.hash" :hash="item.hash" :text="item.text" :selected="currentHash === item.hash" />
@@ -35,6 +44,22 @@ export default {
           text: 'Introduction'
         }
       ],
+      installItems: [
+        {
+          hash: '#install-docker',
+          text: 'Docker'
+        },
+        {
+          hash: '#install-docker-compose',
+          text: 'Docker-compose'
+        }
+      ],
+      updateItems: [
+        {
+          hash: '#updating-docker',
+          text: 'Docker'
+        }
+      ],
       bookItems: [
         {
           hash: '#book-structure',
@@ -91,7 +116,7 @@ export default {
       // const scrollingUp = evt.target.scrollTop - this.lastScrollTop < 0
       // this.lastScrollTop = evt.target.scrollTop
 
-      const allItems = this.introItems.concat(this.bookItems).concat(this.podcastItems)
+      const allItems = this.introItems.concat(this.installItems).concat(this.updateItems).concat(this.bookItems).concat(this.podcastItems)
 
       var closestItem = null
       for (let i = 0; i < allItems.length; i++) {

package.json

@@ -11,10 +11,10 @@
   },
   "dependencies": {
     "core-js": "^3.15.1",
-    "nuxt": "^2.15.7"
+    "nuxt": "^2.15.8"
   },
   "devDependencies": {
     "@nuxtjs/tailwindcss": "^4.2.0",
     "postcss": "^8.3.5"
   }
-}
+}

pages/devSetup.vue

@@ -0,0 +1,3 @@
+<template>
+    
+</template>

pages/docs.vue

@@ -32,6 +32,18 @@
 
     <div class="w-full bg-white bg-opacity-20 h-px my-8" />
 
+    <docs-install-docker />
+
+    <div class="w-full bg-white bg-opacity-20 h-px my-8" />
+
+    <docs-install-docker-compose />
+
+    <div class="w-full bg-white bg-opacity-20 h-px my-8" />
+
+    <docs-updating-docker />
+
+    <div class="w-full bg-white bg-opacity-20 h-px my-8" />
+
     <docs-book-directory-structure />
 
     <div class="w-full bg-white bg-opacity-20 h-px my-8" />

pages/faq.vue

@@ -0,0 +1,3 @@
+<template>
+    
+</template>

pages/install.vue

@@ -5,7 +5,10 @@
       >Docker Install
     </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. Also available in Unraid Community Apps.</p>
+
+    <p class="text-error">Note: Before coping and pasting the below command from a teminal window type <code class="language-bash"> id </code> This will output your UID (User ID) and your GID (Group ID for Docker)</p>
+    
 
     <pre>
         <code class="language-bash">docker pull ghcr.io/advplyr/audiobookshelf
@@ -32,6 +35,47 @@ docker run -d \
 
     <div class="w-full h-px bg-gray-400 my-6" />
 
+    <br />
+
+        <h1 id="docker" class="text-3xl mb-2 -ml-8">
+      <nuxt-link to="#docker"><span class="material-icons text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
+      >Docker-compose Setup
+    </h1>
+
+    <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="text-error">Note: Before coping and pasting the below information into a Docker-compose file. You need to run the following command from a teminal window type <code class="language-bash">id</code> This will output your UID (User ID) and your GID (Group ID for Docker)</p>
+    
+
+<pre>
+            <code class="language-bash">version: "3.7"
+services:
+  audiobookshelf:
+    image: ghcr.io/advplyr/audiobookshelf:latest
+    environment:
+      - AUDIOBOOKSHELF_UID=99
+      - AUDIOBOOKSHELF_GID=100
+    ports:
+      - 13378:80
+    volumes:
+      - &#60;/path/to/your/audiobooks&#62;:/audiobooks
+      - &#60;/path/to/your/podcasts&#62;:/podcasts
+      - &#60;/path/to/config&#62;:/config
+      - &#60;/path/to/metadata&#62;:/metadata
+            
+            </code>
+        </pre>
+
+        <p class="text-error">Note: Remember to change the path to your acutal 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-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 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 class="w-full h-px bg-gray-400 my-6" />
+
     <br />
 
     <h1 id="linux" class="text-3xl mb-4 -ml-8">
@@ -98,6 +142,56 @@ sudo apt install ./audiobookshelf_2.0.2_amd64.deb</code>
 
     <div class="w-full bg-white bg-opacity-20 h-px my-8" />
 
+    <h1 id="updating" class="text-3xl mb-4 -ml-8">
+      <nuxt-link to="updating"><span class="material-icons text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
+      >Updating Instructions
+    </h1>
+
+    <h1 id="docker-update" class="text-3xl mb-2 -ml-8">
+      <nuxt-link to="#docker-update"><span class="material-icons text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
+      >Docker Update
+    </h1>
+
+    <p>To update docker please run the following commands.</p>
+
+    <pre>
+    <code class="language-bash">docker stop audiobookshelf
+docker rm audiobookshelf
+docker image prune -a
+docker pull ghcr.io/advplyr/audiobookshelf:latest
+docker start audiobookshelf
+    </code>
+    </pre>
+
+    <div class="w-full bg-white bg-opacity-20 h-px my-8" />
+
+    <h1 id="docker-compose-update" class="text-3xl mb-2 -ml-8">
+      <nuxt-link to="#docker-compose-update"><span class="material-icons text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
+      >Docker-Compose Update
+    </h1>
+
+    <p>To update Docker-compose please run one of the following commands.</p>
+    <p class="text-error">Note: To check which version of Docker Compose you are running run the following:<code class="language-bash">docker-compose --version</code> or <code class="language-bash">docker compose version</code></p>
+    
+<p> Docker Compose V1
+  <pre>
+    <code class="language-bash">docker-compose --file <path/to/config>/docker-compose.yml pull
+docker-compose --file <path/to/config>/docker-compose.yml up -d
+    </code>
+    </pre>
+
+</p>
+<p> Docker Compose V2
+  <pre>
+    <code class="language-bash">docker compose --file <path/to/config>/docker-compose.yml pull
+docker compose --file <path/to/config>/docker-compose.yml up -d
+    </code>
+    </pre>
+
+</p>
+
+    <div class="w-full bg-white bg-opacity-20 h-px my-8" />
+
     <h1 id="reverse-proxy" class="text-3xl mb-4 -ml-8">
       <nuxt-link to="#reverse-proxy"><span class="material-icons text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
       >Reverse Proxy Setup

pages/proxy.vue

@@ -0,0 +1,3 @@
+<template>
+    
+</template>