Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ScaleCity/docker-bookstack

BookStack in a container
https://github.com/ScaleCity/docker-bookstack

Last synced: 3 months ago
JSON representation

BookStack in a container

Awesome Lists containing this project

README

        

# Forked from [solidnerd/docker-bookstack](https://github.com/SolidNerd/docker-bookstack)

* Updated to 21.05.3

## Docker Image For [BookStack](https://github.com/ssddanbrown/BookStack)

[![Build Status](https://travis-ci.org/scalecity/docker-bookstack.svg?branch=master)](https://travis-ci.org/scalecity/docker-bookstack) [![](https://images.microbadger.com/badges/image/scalecity/bookstack.svg)](https://microbadger.com/images/scalecity/bookstack "Get your own image badge on microbadger.com") [![](https://images.microbadger.com/badges/commit/scalecity/bookstack.svg)](https://microbadger.com/images/scalecity/bookstack "Get your own commit badge on microbadger.com") [![](https://images.microbadger.com/badges/version/scalecity/bookstack.svg)](https://microbadger.com/images/scalecity/bookstack "Get your own version badge on microbadger.com") [![](https://images.microbadger.com/badges/license/scalecity/bookstack.svg)](https://microbadger.com/images/scalecity/bookstack "Get your own license badge on microbadger.com")

## Current Version: [21.05.3](https://github.com/ScaleCity/docker-bookstack/blob/master/Dockerfile)

### Changes

In 0.28.0 we changed the container http port from 80 to 8080 to allow root privileges to be dropped
In 0.12.2 we removed `DB_PORT` . You can now specify the port via `DB_HOST` like `DB_HOST=mysql:3306`

### Quickstart

With Docker Compose is a Quickstart very easy. Run the following command:

```
docker-compose up
```

and after that open your Browser and go to [http://localhost:8080](http://localhost:8080) . You can login with username '[email protected]' and password 'password'.

### Issues

If you have any issues feel free to create an [issue on GitHub](https://github.com/ScaleCity/docker-bookstack/issues).

### How to use the Image without Docker compose

Note that if you want to use LDAP, `$` has to be escape like `\$`, i.e. `-e "LDAP_USER_FILTER"="(&(uid=\${user}))"`

Networking changed in Docker v1.9, so you need to do one of the following steps.

#### Docker < v1.9

1. MySQL Container:

```bash
docker run -d \
-p 3306:3306 \
-e MYSQL_ROOT_PASSWORD=secret \
-e MYSQL_DATABASE=bookstack \
-e MYSQL_USER=bookstack \
-e MYSQL_PASSWORD=secret \
--name bookstack_db \
mysql:5.7.21
```
2. BookStack Container:

```bash
docker run -d --link bookstack_db_:mysql \
-p 8080:8080 \
--name bookstack_21.05.3 \
registry.scalecity.io/opensource/bookstack:21.05.3
```

#### Docker 1.9+

1. Create a shared network:

```bash
docker network create bookstack_nw
```

2. Run MySQL container :

```bash
docker run -d --net bookstack_nw \
-e MYSQL_ROOT_PASSWORD=secret \
-e MYSQL_DATABASE=bookstack \
-e MYSQL_USER=bookstack \
-e MYSQL_PASSWORD=secret \
--name="bookstack_db" \
mysql:5.7.21
```

3. Run BookStack Container

```bash
docker run -d --net bookstack_nw \
-e DB_HOST=bookstack_db:3306 \
-e DB_DATABASE=bookstack \
-e DB_USERNAME=bookstack \
-e DB_PASSWORD=secret \
-p 8080:8080 \
--name="bookstack_21.05.3" \
registry.scalecity.io/opensource/bookstack:21.05.3
```

#### Volumes
To access your `.env` file and important bookstack folders on your host system change `` in the following line to your host directory and add it then to your run command:

```bash
--mount type=bind,source=/.env,target=/var/www/bookstack/.env \
-v :/var/www/bookstack/public/uploads \
-v :/var/www/bookstack/storage/uploads
```
In case of a windows host machine the .env file has to be already created in the host directory otherwise a folder named .env will be created.

After these steps you can visit [http://localhost:8080](http://localhost:8080) . You can login with username '[email protected]' and password 'password'.

### Inspiration

This is a fork of [Kilhog/docker-bookstack](https://github.com/Kilhog/docker-bookstack). Kilhog did the intial work, but I want to go in a different direction.