maxkratz/community-tutorials
1
0
Fork 0
mirror of https://github.com/maxkratz/community-tutorials.git synced 2024-09-08 00:02:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update 01-en.md

Browse source
This commit is contained in:
Christoph 2023-06-15 17:43:11 +02:00 committed by GitHub
parent 472e1c671c
commit 92856b0c38
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
community-tutorials/how-to-install-bookstack-with-docker/01-en.md
View file

@ -1,6 +1,6 @@
---
title: Setup Bookstack on a debian server
description: How to install a Bookstack Server with docker-compose
title: Set up BookStack on a Debian Server
description: How to install a BookStack server using docker-compose.
level: [beginner]
updated_at: 2023-06-07
slug: setup-bookstack-with-docker
@ -11,42 +11,43 @@ author_bio:
tags: [linux, wiki, docker, docker-compose]
netcup_product_url: https://www.netcup.de/bestellen/produkt.php?produkt=2948
language: en
available_languages: [de, en]
available_languages: [en]
---
# Introduction
In this tutorial I describe how we can install the wiki software Bookstack on a Debian 11 server.
In this tutorial, I'm going to describe how you can install the BookStack wiki software on a Debian 11 server.
We use Docker for installation to keep the installation relatively simple. Bookstack is a free software for documenting certain information. Among other things, the software supports uploading files and embedding source code. Therefore, this wiki is suitable for all kinds of people who are interested in documenting things.
We use Docker for the installation to keep the process relatively simple. BookStack is a free software for organizing and storing information. Among other things, the software supports uploading files and embedding source code. This is why this wiki solution is suitable for people interested in documentation work.
The reading time of this article is approximately 10 minutes. A time of about 30 minutes should be planned for the implementation of this project. In terms of difficulty, this is in the beginner range. In this tutorial, we will use the hostname srv1.quicksrv.de. This can be chosen freely. You should be able to open our wiki with a browser on the website wiki.website.de afterwards.
The reading time of this article is approximately 10 minutes. A time of about 30 minutes should be planned for the implementation of this project. In terms of difficulty, this project is in the beginner range. In this tutorial, we'll use the hostname srv1.quicksrv.de. Please note that the hostname will be different in your case. After completing the instructions in this tutorial, you should be able to access your wiki via a browser at wiki.yourdomain.de.
# Requirements
The following are the requirements for the system to successfully complete the installation:
- Debian 11 operating system
- Administration user
- SSH access or console access
- At least 30 GB hard disk space (depending on the scope and type of documentation)
These are the requirements to follow the instructions in this tutorial:
- netcup Root or vServer
- Debian 11
- superuser
- SSH or Console access
- At least 30 GB Hard Disk space (depending on the scope and type of documentation)
- At least 1 GB of RAM -
- At least 1 CPU core
- At least 1 CPU Core
- One IPv4 or IPv6 address
For this project, the smallest VPS 200 G10s vServer model is sufficient.
For this project, the smallest netcup VPS, the VPS 200 G10s vServer, is sufficient.
# Step 1 - Ordering the VPS
At the time of the creation of this tutorial (June 2023), the recommended product to be used as SSH proxy is [VPS 200 G10s](https://www.netcup.de/bestellen/produkt.php?produkt=2948).
Existing customers can add the product easily and quickly.
# Step 2 - Basic configuration of the server
After provisioning of the server and the first login with the username `root` and the password sent by email, the first step is to update the basic configuration of the server.
After provisioning the server and logging in for the first time with the username `root` and the password sent by email, the first step is to update the basic configuration of the server.
1. Change the root password by means of `passwd`.
2. Import the current security updates with `apt-get update && apt-get upgrade -y`.
3. Change the hostname with hostname with `hostnamectl set-hostname NEW-NAME`
3. Change the hostname with `hostnamectl set-hostname NEW-NAME`
# Step 3 - Install docker on the server
After the basic server installation, we now need to install Docker. Docker allows us to launch applications in so-called containers, so as not to have problems with dependencies on multiple applications. Furthermore, an application is much easier to install and update because the user does not have to deal with the installation of different packages.
# Step 3 - Install Docker on the server
After the basic server installation, we now need to install Docker. Docker allows us to launch applications in so-called containers, so as to avoid any possible problems with dependencies on multiple applications. Also, an application is much easier to install and update, as the user does not have to deal with installing different packages.
1. To install Docker, the following script must be executed:
`
`apt update && apt upgrade -y && apt install sudo -y`
@ -60,17 +61,17 @@ After the basic server installation, we now need to install Docker. Docker allow
2. To verify the installation, we enter the `docker compose version` command. The command line should now give us a version number. With this, we can make sure that our installation was successful and we can start installing our application.
# Step 4 - Install bookstack on the server
To install Bookstack now, in the first step we need a folder on our server to put the files there. We create this under `/opt/bookstack`. The location can be chosen freely.
# Step 4 - Install BookStack on the server
Now, in order to install BookStack, the first step we need is to create a folder on our server to put the files there. We create this folder under `/opt/bookstack`. The location can be chosen freely.
`mkdir /opt/bookstack`
In the next step we change to the directory with the `cd` command.
In the next step, we change to the directory with the `cd` command.
`cd /opt/bookstack`
There we now create the `docker-compose.yml`, which is to be understood as the configuration file of our application.
There, we now create the `docker-compose.yml`, which is to be understood as the configuration file of our application.
We create the file with the nano editor. To do this, we enter the following command:
`nano docker-compose.yml`
In it we add the following content:
We add the following content to the file:
```
version: "2"
@ -110,20 +111,23 @@ services:
restart: unless-stopped
```
In the file we now only change the following things:
- Under `APP_URL` we enter the domain for our wiki
- Under `DB_PASS` we enter a password of the database user
We now only have to make the following changes within the file:
- Under `APP_URL` we enter the domain for our wiki.
- Under `DB_PASS` we enter a password for the database user.
- Under `MYSQL_ROOT_PASSWORD` we enter a strong password.
- Under `MYSQL_PASSWORD` we give the database user a password, which we also have to enter in the first point.
Now we can start the application with `docker compose up -d`.
The process is taking a while now, but after max. 5 minutes we should be able to reach the website.
The Default login is with username: `admin@admin.com`and password: `password`.
The process will take a while, but after a maximum of 5 minutes we should be able to reach the website.
The default login uses the following credentials:
username: `admin@admin.com`
password: `password`
# Conclusion
The wiki system can now be used. The settings can be adjusted in the settings.
The wiki can now be used. Please adjust the settings depending on your needs.
# Licence
# License
[MIT](https://github.com/netcup-community/community-tutorials/blob/main/LICENSE)
@ -138,10 +142,10 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
# Contributor's Certificate of Origin
By making a contribution to this project, I certify that:
1) The contribution was created in whole or in part by me and I have the right to submit it under the licence indicated in the file; or
1) The contribution was created in whole or in part by me and I have the right to submit it under the license indicated in the file; or
2) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate licence and I have the right under that licence to submit that work with modifications, whether created in whole or in part by me, under the same licence (unless I am permitted to submit under a different licence), as indicated in the file; or
2) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same license (unless I am permitted to submit under a different license), as indicated in the file; or
3) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
4) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the licence(s) involved.
4) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the license(s) involved.