Homelab/Docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme standartization.

Browse Source
This commit is contained in:
Maksym Buz
2025-08-23 23:35:06 +02:00
parent 4bde51cb96
commit da530d91e1
20 changed files with 284 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
bookstack/README.md
View File

@@ -1,47 +1,26 @@
# Bookstack
# BookStack
[Bookstack](https://www.bookstackapp.com/) is a simple, self-hosted, easy-to-use platform for organizing and storing information.
BookStack is a free and open-source platform for organizing and storing information, essentially functioning as a wiki or documentation system. It is designed to be simple, self-hosted, and easy to use.
## Docker Compose Setup
[BookStack Website](https://www.bookstackapp.com/)
This directory contains a Docker Compose setup for Bookstack.
## Services
### Services
- **bookstack**: The main BookStack application.
- **bookstack_database**: A MariaDB database for BookStack.
- **bookstack**: The Bookstack application itself.
- **bookstack_database**: A MariaDB database for Bookstack.
## How to start
### Volumes
1. Create a `.env` file based on the `.env.example` file.
2. Set the environment variables in the `.env` file.
3. Run `docker-compose up -d` to start the application.
4. The application will be available at the URL you specified in the `APP_URL` environment variable.
- `${PATH_TO_CONFIG}`: Stores the Bookstack configuration files.
- `${PATH_TO_DB}`: Stores the MariaDB database files.
## Setup
### Ports
After starting the application, you can access the web interface and log in with the default credentials:
- `6875:80`: The Bookstack application is accessible on port 6875.
- **Email**: `admin@admin.com`
- **Password**: `password`
## Usage
1. Create a `.env` file with the following variables:
```
# Password for bookstack MySQL user
DB_USER_PASS=<your_strong_pass>
# Password for root MySQL user
DB_ROOT_PASS=<your_strongest_pass>
# Directory, where the bookstack itself will store the files
PATH_TO_CONFIG=/path/to/bookstack/config
# Directory, where MySQL data will be stored
PATH_TO_DB=/path/to/db/data
# Your timezone
TZ=Europe/Warsaw
# The IP:port or URL your application will be accessed on (ie. http://192.168.1.1:6875 or https://bookstack.mydomain.com
APP_URL=https://bookstack.example.com
```
2. Run `docker-compose up -d` to start the containers.
You will be prompted to change the password after your first login.