|
|
@@ -0,0 +1,83 @@
|
|
|
+ <!DOCTYPE html>
|
|
|
+ <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
|
|
|
+ <head>
|
|
|
+ <title>Run BookStack - Documentation/Wiki Platform - in Docker</title>
|
|
|
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
+ <meta charset="UTF-8">
|
|
|
+ <meta name="keywords" content="Browser Based,Docker Made Easy,Home Lab,Home Lab Ideas,Install Guide,Self-Hosted,Web Based,Web Based Tools,Debian,Docker,Docker Container,Docker How To,Docker Made Simple,Docker Simplified,Docker Tutorial,Homelab,Linux,MariaDB,MySQL,PHP,PHP Based Application,Ubuntu,BookStack,Knowledge Base,KB,How To,Tutorial,i12bretro">
|
|
|
+ <meta name="author" content="i12bretro">
|
|
|
+ <meta name="description" content="Run BookStack - Documentation/Wiki Platform - in Docker">
|
|
|
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
+ <meta name="revised" content="04/20/2024 05:00:40 AM" />
|
|
|
+ <link rel="icon" type="image/x-icon" href="includes/favicon.ico">
|
|
|
+ <script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
|
|
|
+ <script type="text/javascript" src="includes/js/steps.js"></script>
|
|
|
+ <link href="css/steps.css" rel="stylesheet" type="text/css" />
|
|
|
+ </head>
|
|
|
+ <body>
|
|
|
+ <div id="gridContainer">
|
|
|
+ <div class="topMargin"></div>
|
|
|
+ <div id="listName" class="topMargin">
|
|
|
+ <h1>Run BookStack - Documentation/Wiki Platform - in Docker</h1>
|
|
|
+ </div>
|
|
|
+ <div></div>
|
|
|
+ <div id="content">
|
|
|
+ <h2>What is BookStack?</h2>
|
|
|
+
|
|
|
+<blockquote><em>BookStack is an opinionated wiki system that provides a pleasant and simple out-of-the-box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience. -<a href="https://github.com/BookStackApp/BookStack" target="_blank">https://github.com/BookStackApp/BookStack</a></em></blockquote>
|
|
|
+
|
|
|
+<h2>Installing Docker</h2>
|
|
|
+
|
|
|
+<ol>
|
|
|
+ <li>Log into the Linux based device</li>
|
|
|
+ <li>Run the following commands in the terminal
|
|
|
+ <div class="codeBlock"># install prerequisites<br />
|
|
|
+ sudo apt install apt-transport-https ca-certificates curl software-properties-common gnupg-agent -y<br />
|
|
|
+ # add docker gpg key<br />
|
|
|
+ curl -fsSL https://download.docker.com/linux/$(awk -F'=' '/^ID=/{ print $NF }' /etc/os-release)/gpg | sudo apt-key add -<br />
|
|
|
+ # add docker software repository<br />
|
|
|
+ sudo add-apt-repository "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/$(awk -F'=' '/^ID=/{ print $NF }' /etc/os-release) $(lsb_release -cs) stable"<br />
|
|
|
+ # install docker<br />
|
|
|
+ sudo apt install docker-ce docker-compose containerd.io -y<br />
|
|
|
+ # enable and start docker service<br />
|
|
|
+ sudo systemctl enable docker && sudo systemctl start docker<br />
|
|
|
+ # add the current user to the docker group<br />
|
|
|
+ sudo usermod -aG docker $USER<br />
|
|
|
+ # reauthenticate for the new group membership to take effect<br />
|
|
|
+ su - $USER</div>
|
|
|
+ </li>
|
|
|
+</ol>
|
|
|
+
|
|
|
+<h2>Running BookStack</h2>
|
|
|
+
|
|
|
+<ol>
|
|
|
+ <li>Continue with the following commands in a terminal window
|
|
|
+ <div class="codeBlock"># list current uid and gid, note these for later<br />
|
|
|
+ id $user<br />
|
|
|
+ # create working directories<br />
|
|
|
+ mkdir ~/docker/bookstack/config -p && mkdir ~/docker/mariadb -p<br />
|
|
|
+ # set ownership on the working directories<br />
|
|
|
+ sudo chown "$USER":"$USER" ~/docker -R<br />
|
|
|
+ # run the mariadb docker container<br />
|
|
|
+ docker run -d --name mariadb -e MYSQL_ROOT_PASSWORD=r00tp@$$ -e MYSQL_USER=bookstack_rw -e MYSQL_PASSWORD='B00k$t@ck!' -e MYSQL_DATABASE=bookstack -v ~/docker/mariadb:/var/lib/mysql -p 3306:3306 --restart=unless-stopped mariadb:latest<br />
|
|
|
+ # run the bookstack docker image<br />
|
|
|
+ # replace PUID, GUID with the output of the id $user command above<br />
|
|
|
+ # replace DB_HOST and APP_URL with the docker host DNS name or IP address<br />
|
|
|
+ docker run -d --name bookstack -e PUID=1000 -e PGID=1000 -e TZ=America/New_York -e APP_URL=http://ubuntuserver.local:6875 -e DB_HOST=172.17.0.1 -e DB_PORT=3306 -e DB_USER=bookstack_rw -e DB_PASS='B00k$t@ck!' -e DB_DATABASE=bookstack -p 6875:80 -v ~/docker/bookstack/config:/config --restart unless-stopped lscr.io/linuxserver/bookstack:latest</div>
|
|
|
+ </li>
|
|
|
+ <li>Open a web browser and navigate to http://DNSorIP:6875</li>
|
|
|
+ <li>Login with the username admin@admin.com and the password password</li>
|
|
|
+ <li>Click the user dropdown at the top right > My Account</li>
|
|
|
+ <li>Update the user name and email address as needed > Click Save</li>
|
|
|
+ <li>Select Access & Security from the left navigation menu</li>
|
|
|
+ <li>Enter and confirm a new password > Click Update</li>
|
|
|
+ <li>Click the user dropdown at the top right > Logout</li>
|
|
|
+ <li>Log back in using the updated email address and password</li>
|
|
|
+ <li>Welcome to BookStack</li>
|
|
|
+</ol>
|
|
|
+
|
|
|
+<p>Documentation: <a href="https://hub.docker.com/r/linuxserver/bookstack" target="_blank">https://hub.docker.com/r/linuxserver/bookstack</a></p> </div>
|
|
|
+ </div>
|
|
|
+ </body>
|
|
|
+ </html>
|
|
|
+
|
i12bretro