kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
8bc2e81e0e
commit
0c50cdfadf
|
|
@ -1,12 +1,19 @@
|
|||
# linuxserver/bookstack
|
||||
# [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
|
||||
|
||||
[](https://github.com/linuxserver/docker-bookstack/releases) [](https://microbadger.com/images/linuxserver/bookstack) [](https://microbadger.com/images/linuxserver/bookstack) [](https://hub.docker.com/r/linuxserver/bookstack) [](https://hub.docker.com/r/linuxserver/bookstack) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-bookstack/releases)
|
||||
[](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/bookstack)
|
||||
[](https://hub.docker.com/r/linuxserver/bookstack)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/index.html)
|
||||
|
||||
[Bookstack](https://github.com/BookStackApp/BookStack) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
|
||||
|
||||
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
|
||||
|
||||
For more information on BookStack visit their website and check it out: [https://www.bookstackapp.com](https://www.bookstackapp.com)
|
||||
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -17,18 +24,19 @@ Simply pulling `linuxserver/bookstack` should retrieve the correct image for you
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=bookstack \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -44,6 +52,7 @@ docker create \
|
|||
linuxserver/bookstack
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -83,71 +92,77 @@ services:
|
|||
volumes:
|
||||
- <path to data>:/config
|
||||
restart: unless-stopped
|
||||
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `80` | will map the container's port 80 to port 6875 on the host |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `DB_HOST=<yourdbhost>` | for specifying the database host |
|
||||
| `DB_USER=<yourdbuser>` | for specifying the database user |
|
||||
| `DB_PASS=<yourdbpass>` | for specifying the database password |
|
||||
| `DB_DATABASE=bookstackapp` | for specifying the database to be used |
|
||||
| `APP_URL=http://your.site.here.xyz` | for specifying the url your application will be accessed on \(required for correct operation of reverse proxy\) |
|
||||
| `APP_URL=http://your.site.here.xyz` | for specifying the url your application will be accessed on (required for correct operation of reverse proxy) |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | this will store any uploaded data on the docker host |
|
||||
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
When using volumes \(`-v` flags\), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
The default username is admin@admin.com with the password of **password**, access the container at [http://dockerhost:6875](http://dockerhost:6875).
|
||||
|
||||
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here [https://hub.docker.com/r/linuxserver/mariadb/](https://hub.docker.com/r/linuxserver/mariadb/).
|
||||
The default username is admin@admin.com with the password of **password**, access the container at http://dockerhost:6875.
|
||||
|
||||
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
|
||||
|
||||
|
||||
If you intend to use this application behind a subfolder reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work
|
||||
|
||||
Documentation for BookStack can be found at [https://www.bookstackapp.com/docs/](https://www.bookstackapp.com/docs/)
|
||||
|
||||
### Advanced Users \(full control over the .env file\)
|
||||
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
|
||||
|
||||
### Advanced Users (full control over the .env file)
|
||||
If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
|
||||
|
||||
When you create the container, do not set any arguments for any SQL settings, or APP\_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. When you create the container, do not set any arguments for any SQL settings, or APP\_URL. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
|
||||
|
||||
When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
|
||||
|
||||
#### PDF Rendering
|
||||
|
||||
[wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at [https://www.bookstackapp.com/docs/admin/pdf-rendering/](https://www.bookstackapp.com/docs/admin/pdf-rendering/).
|
||||
[wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at https://www.bookstackapp.com/docs/admin/pdf-rendering/.
|
||||
|
||||
The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/wkhtmltopdf`.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -172,4 +187,3 @@ The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/
|
|||
* **08.10.18:** - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
|
||||
* **23.09.28:** - Updates pre-release
|
||||
* **02.07.18:** - Initial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue