kopia lustrzana https://github.com/linuxserver/docker-documentation
303 wiersze
12 KiB
Markdown
Executable File
303 wiersze
12 KiB
Markdown
Executable File
---
|
|
title: wikijs
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read https://github.com/linuxserver/docker-wikijs/blob/master/.github/CONTRIBUTING.md -->
|
|
# [linuxserver/wikijs](https://github.com/linuxserver/docker-wikijs)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fwikijs)
|
|
[](https://github.com/linuxserver/docker-wikijs)
|
|
[](https://github.com/linuxserver/docker-wikijs/releases)
|
|
[](https://github.com/linuxserver/docker-wikijs/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-wikijs/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/wikijs)
|
|
[](https://hub.docker.com/r/linuxserver/wikijs)
|
|
[](https://hub.docker.com/r/linuxserver/wikijs)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-wikijs/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/wikijs/latest/index.html)
|
|
|
|
[Wikijs](https://github.com/Requarks/wiki) A modern, lightweight and powerful wiki app built on NodeJS.
|
|
|
|
[](https://github.com/Requarks/wiki)
|
|
|
|
## Supported Architectures
|
|
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/wikijs:latest` 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 | Available | Tag |
|
|
| :----: | :----: | ---- |
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
|
| armhf | ❌ | |
|
|
|
|
## Application Setup
|
|
|
|
Please note that the database configuration environment variables will apply _on first run only_, after which you will need to directly edit /config/config.yml to change your settings.
|
|
|
|
For more information please see the [official documentation](https://docs.requarks.io/).
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
services:
|
|
wikijs:
|
|
image: lscr.io/linuxserver/wikijs:latest
|
|
container_name: wikijs
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Etc/UTC
|
|
- DB_TYPE=sqlite #optional
|
|
- DB_HOST= #optional
|
|
- DB_PORT= #optional
|
|
- DB_NAME= #optional
|
|
- DB_USER= #optional
|
|
- DB_PASS= #optional
|
|
volumes:
|
|
- /path/to/wikijs/config:/config
|
|
- /path/to/data:/data
|
|
ports:
|
|
- 3000:3000
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=wikijs \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Etc/UTC \
|
|
-e DB_TYPE=sqlite `#optional` \
|
|
-e DB_HOST= `#optional` \
|
|
-e DB_PORT= `#optional` \
|
|
-e DB_NAME= `#optional` \
|
|
-e DB_USER= `#optional` \
|
|
-e DB_PASS= `#optional` \
|
|
-p 3000:3000 \
|
|
-v /path/to/wikijs/config:/config \
|
|
-v /path/to/data:/data \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/wikijs:latest
|
|
```
|
|
|
|
## Parameters
|
|
|
|
Containers 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`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `3000` | Port for Wiki.js's web interface. |
|
|
|
|
### Environment Variables (`-e`)
|
|
|
|
| Env | Function |
|
|
| :----: | --- |
|
|
| `PUID=1000` | for UserID - see below for explanation |
|
|
| `PGID=1000` | for GroupID - see below for explanation |
|
|
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
|
| `DB_TYPE=sqlite` | Set to sqlite (default) or postgres depending on the database engine you wish to use |
|
|
| `DB_HOST=` | DB hostname (postgres only) |
|
|
| `DB_PORT=` | DB port (postgres only) |
|
|
| `DB_NAME=` | DB name (postgres only) |
|
|
| `DB_USER=` | DB username (postgres only) |
|
|
| `DB_PASS=` | DB password (postgres only) |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Persistent config files |
|
|
| `/data` | Where Wiki.js data is stored. |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-e FILE__MYVAR=/run/secrets/mysecretvariable
|
|
```
|
|
|
|
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
|
|
|
|
## Umask for running applications
|
|
|
|
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
|
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
|
|
|
## 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`.
|
|
|
|
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 your_user` as below:
|
|
|
|
```bash
|
|
id your_user
|
|
```
|
|
|
|
Example output:
|
|
|
|
```text
|
|
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=wikijs "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
|
|
```bash
|
|
docker exec -it wikijs /bin/bash
|
|
```
|
|
|
|
* To monitor the logs of the container in realtime:
|
|
|
|
```bash
|
|
docker logs -f wikijs
|
|
```
|
|
|
|
* Container version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' wikijs
|
|
```
|
|
|
|
* Image version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wikijs:latest
|
|
```
|
|
|
|
## Updating Info
|
|
|
|
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
|
|
|
Below are the instructions for updating containers:
|
|
|
|
### Via Docker Compose
|
|
|
|
* Update images:
|
|
* All images:
|
|
|
|
```bash
|
|
docker-compose pull
|
|
```
|
|
|
|
* Single image:
|
|
|
|
```bash
|
|
docker-compose pull wikijs
|
|
```
|
|
|
|
* Update containers:
|
|
* All containers:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
* Single container:
|
|
|
|
```bash
|
|
docker-compose up -d wikijs
|
|
```
|
|
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Via Docker Run
|
|
|
|
* Update the image:
|
|
|
|
```bash
|
|
docker pull lscr.io/linuxserver/wikijs:latest
|
|
```
|
|
|
|
* Stop the running container:
|
|
|
|
```bash
|
|
docker stop wikijs
|
|
```
|
|
|
|
* Delete the container:
|
|
|
|
```bash
|
|
docker rm wikijs
|
|
```
|
|
|
|
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Image Update Notifications - Diun (Docker Image Update Notifier)
|
|
|
|
!!! tip
|
|
|
|
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
|
|
|
|
## Building locally
|
|
|
|
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
|
|
|
```bash
|
|
git clone https://github.com/linuxserver/docker-wikijs.git
|
|
cd docker-wikijs
|
|
docker build \
|
|
--no-cache \
|
|
--pull \
|
|
-t lscr.io/linuxserver/wikijs:latest .
|
|
```
|
|
|
|
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
|
|
|
```bash
|
|
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
|
```
|
|
|
|
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
|
|
|
## Versions
|
|
|
|
* **23.12.23:** - Rebase to Alpine 3.19.
|
|
* **25.08.22:** - Rebase to Alpine 3.18.
|
|
* **07.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)
|
|
* **21.03.23:** - Restore git and openssh packages for git storage support.
|
|
* **21.03.23:** - Create dummy /etc/os-release to fix System Info page.
|
|
* **10.10.22:** - Rebasing to alpine 3.16, migrate to s6v3.
|
|
* **23.01.21:** - Rebasing to alpine 3.13.
|
|
* **01.06.20:** - Rebasing to alpine 3.12.
|
|
* **28.04.20:** - Added python dependency for some NPM modules as well as git for storage module
|
|
* **14.12.19:** - Initial Release.
|