kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
f8c8ec4a43
commit
435a0f7f27
|
|
@ -1,32 +1,42 @@
|
|||
# linuxserver/bookstack
|
||||
# [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
|
||||
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/bookstack) [](https://microbadger.com/images/linuxserver/bookstack)  
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](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://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
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
|
||||
|
||||
Simply pulling `linuxserver/bookstack` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
|
||||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container.
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=bookstack \
|
||||
-e PUID=1001 \
|
||||
|
|
@ -42,11 +52,12 @@ docker create \
|
|||
linuxserver/bookstack
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```text
|
||||
```yaml
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
|
|
@ -71,18 +82,19 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Container 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`)
|
||||
|
||||
| Port | Function |
|
||||
| :---: | :--- |
|
||||
| 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=1001` | for UserID - see below for explanation |
|
||||
| `PGID=1001` | for GroupID - see below for explanation |
|
||||
| `DB_HOST=<yourdbhost>` | for specifying the database host |
|
||||
|
|
@ -91,21 +103,23 @@ Container images are configured using parameters passed at runtime \(such as tho
|
|||
| `DB_DATABASE=bookstackapp` | for specifying the database to be used |
|
||||
| `APPURL=your.site.here.xyz` | for specifying the url your application will be accessed on |
|
||||
|
||||
### 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=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
|
@ -118,29 +132,25 @@ Once the MariaDB container is deployed, you can enter the following commands int
|
|||
|
||||
**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost
|
||||
|
||||
```bash
|
||||
mysql -u root -p
|
||||
```
|
||||
|
||||
```sql
|
||||
from shell: mysql -u root -p
|
||||
CREATE DATABASE bookstackapp;
|
||||
GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword';
|
||||
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@%;
|
||||
FLUSH PRIVILEGES;
|
||||
```
|
||||
|
||||
Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as with the correct data.
|
||||
Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as <yourdbuser> with the correct data.
|
||||
|
||||
Then docker start bookstackapp to start the container. You should then be able to access the container at [http://dockerhost:6875](http://dockerhost:6875)
|
||||
Then docker start bookstackapp to start the container. You should then be able to access the container at http://dockerhost:6875
|
||||
|
||||
Default username is admin@admin.com with password of **password**
|
||||
|
||||
If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APPURL` environment variable is set, or it will not work
|
||||
|
||||
Documentation can be found at [https://www.bookstackapp.com/docs/](https://www.bookstackapp.com/docs/)
|
||||
Documentation can be found at https://www.bookstackapp.com/docs/
|
||||
|
||||
### Advanced Users
|
||||
|
||||
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 arguements for SQL or APPURL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
|
||||
|
|
@ -149,13 +159,17 @@ When you create the container, do not set any arguements for SQL or APPURL. The
|
|||
|
||||
Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running: `docker exec -it bookstack /bin/bash`
|
||||
* To monitor the logs of the container in realtime: `docker logs -f bookstack`
|
||||
* container version number
|
||||
* Shell access whilst the container is running:
|
||||
* `docker exec -it bookstack /bin/bash`
|
||||
* To monitor the logs of the container in realtime:
|
||||
* `docker logs -f bookstack`
|
||||
* Container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack`
|
||||
* image version number
|
||||
* Image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/bookstack`
|
||||
|
||||
## Versions
|
||||
|
|
@ -166,4 +180,3 @@ Some simple docker-compose files are included for you to get started with. You w
|
|||
* **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