|
1 | | - |
2 | 1 | [linuxserverurl]: https://linuxserver.io |
3 | | -[forumurl]: https://discourse.linuxserver.io |
4 | | -[ircurl]: https://www.linuxserver.io/irc/ |
5 | | -[appurl]: https://www.bookstackapp.com |
6 | | -[dockerfileurl]: https://github.com/linuxserver/docker-bookstack/blob/master/Dockerfile |
7 | | -[hub]: https://hub.docker.com/r/<image-name>/ |
8 | | - |
9 | | -[][linuxserverurl] |
10 | | - |
11 | | -## Contact information:- |
12 | | - |
13 | | -| Type | Address/Details | |
14 | | -| :---: | --- | |
15 | | -| Discord | [Discord](https://discord.gg/YWrKVTn) | |
16 | | -| Forum | [Linuserver.io forum][forumurl] | |
17 | | - |
18 | | - |
19 | | - |
20 | | - |
21 | | -The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :- |
22 | | - |
23 | | - + regular and timely application updates |
24 | | - + easy user mappings |
25 | | - + custom base image with s6 overlay |
26 | | - + weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth |
27 | | - + security updates |
28 | | - |
29 | | -# docker-bookstack |
30 | | - |
31 | | -[][dockerfileurl] |
32 | | - |
33 | | -[BookStack](https://www.bookstackapp.com) 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. |
34 | | - |
35 | | -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. |
36 | | - |
37 | | -For more information on BookStack visit their website and check it out: https://www.bookstackapp.com |
38 | | - |
39 | | -## Usage |
40 | | - |
41 | | -This container depends on an SQL server to provide the storage database. If you have one set up already (Docker or otherwise) then continue but if not then deploy a MariaDB container from [this dockerhub page](https://hub.docker.com/r/linuxserver/mariadb/) |
42 | | -``` |
43 | | -docker create \ |
44 | | - --name=bookstackapp \ |
45 | | - -v <path to data>:/config \ |
46 | | - -e PGID=<gid> -e PUID=<uid> \ |
47 | | - -e DB_HOST=<yourdbhost> \ |
48 | | - -e DB_USER=<yourdbuser> \ |
49 | | - -e DB_PASS=<yourdbuser> \ |
50 | | - -e DB_DATABASE=bookstackapp |
51 | | - -p 6875:80 \ |
52 | | - docker-bookstack |
53 | | -``` |
54 | | - |
55 | | -It is strongly recommended that this container is used with our LetsEncrypt container so that your BookStack app is served over valid HTTPS. |
56 | | - |
57 | | -## Parameters |
58 | | - |
59 | | -The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. |
60 | | -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. |
61 | | -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 |
62 | | -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80. |
63 | | - |
64 | | -| Parameter | Function | |
65 | | -| :---: | --- | |
66 | | -| `-p 6875:80` | will map the container's port 80 to port 6875 on the host | |
67 | | -| `-v /config` | this will store any uploaded data on the docker host | |
68 | | -| `-e PGID` | for GroupID, see below for explanation | |
69 | | -| `-e PUID` | for UserID, see below for explanation | |
70 | | -| `-e DB_HOST` | for specifying the database host, see below for further explanation | |
71 | | -| `-e DB_USER ` | for specifying the database user | |
72 | | -| `-e DB_PASS ` | for specifying the database password | |
73 | | -| `-e DB_DATABASE ` | for specifying the database to be used | |
74 | | - |
75 | | - |
76 | | -## User / Group Identifiers |
77 | | - |
78 | | -Sometimes 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`. |
79 | | - |
80 | | -Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™. |
81 | | - |
82 | | -In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below: |
83 | | - |
84 | | -``` |
85 | | - $ id <dockeruser> |
86 | | - uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) |
87 | | -``` |
88 | | - |
89 | | -## Setting up the application |
90 | | - |
91 | | -This application is dependent on an SQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container. |
92 | | - |
93 | | -Once the MariaDB container is deployed, you can enter the following commands into the shell of the MariaDB container to create the user, password and database that the app will then use. Replace myuser/mypassword with your own data. |
94 | | - |
95 | | -**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost |
96 | | - |
97 | | -` |
98 | | -from shell: mysql -u root -p |
99 | | -CREATE DATABASE bookstackapp; |
100 | | -GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword'; |
101 | | -GRANT ALL privileges ON 'bookstackapp'.* TO 'myuser'@localhost; |
102 | | -FLUSH PRIVILEGES; |
103 | | -` |
104 | | - |
105 | | -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. |
106 | | - |
107 | | -Then docker start bookstackapp to start the container. You should then be able to access the container at http://dockerhost:6875 |
108 | | - |
109 | | -Default username is admin@admin.com with password of **password** |
110 | | - |
111 | | -Documentation can be found at https://www.bookstackapp.com/docs/ |
| 2 | +[forumurl]: https://forum.linuxserver.io |
| 3 | +[discordurl]: https://discord.gg/YWrKVTn |
| 4 | +[podcasturl]: https://www.linuxserver.io/podcast/ |
112 | 5 |
|
113 | | -## Container access and information. |
| 6 | +[][linuxserverurl] |
114 | 7 |
|
115 | | -| Function | Command | |
116 | | -| :--- | :--- | |
117 | | -| Shell access (live container) | `docker exec -it <container-name> /bin/bash` | |
118 | | -| Realtime container logs | `docker logs -f <container-name>` | |
119 | | -| Container version | `docker inspect -f '{{ index .Config.Labels "build_version" }}' <container-name>` | |
120 | | -| Image version | `docker inspect -f '{{ index .Config.Labels "build_version" }}' <image-name>` | |
121 | | -| Dockerfile | [Dockerfile][dockerfileurl] | |
| 8 | +## This is a Container in active development by the [LinuxServer.io][linuxserverurl] team and is not recommended for use by the general public. |
122 | 9 |
|
123 | | -## Changelog |
| 10 | +If you want to comment\contribute on this container , are looking for support on any of our other work , or are curious about us in general, check out the following. |
124 | 11 |
|
125 | | -| Date | Changes | |
126 | | -| :---: | --- | |
127 | | -| 02.07.18 | Initial Release. | |
| 12 | +* [forum.linuxserver.io][forumurl] |
| 13 | +* [Discord][discordurl] On Discord |
| 14 | +* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! |
0 commit comments