Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/djuuu/ansible-role-wikijs-docker
Install Wiki.js Docker Compose project. Based on LinuxServer.io image https://docs.linuxserver.io/images/docker-wikijs/
https://github.com/djuuu/ansible-role-wikijs-docker
ansib ansible-role docker docker-compose wiki wikijs
Last synced: about 1 month ago
JSON representation
Install Wiki.js Docker Compose project. Based on LinuxServer.io image https://docs.linuxserver.io/images/docker-wikijs/
- Host: GitHub
- URL: https://github.com/djuuu/ansible-role-wikijs-docker
- Owner: Djuuu
- License: other
- Created: 2024-11-11T00:28:26.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T19:46:56.000Z (about 1 month ago)
- Last Synced: 2024-11-22T20:31:35.097Z (about 1 month ago)
- Topics: ansib, ansible-role, docker, docker-compose, wiki, wikijs
- Language: Jinja
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ansible Role: Wikijs-docker
===========================
Install Wiki.js Docker Compose project.
Based on LinuxServer.io image: https://docs.linuxserver.io/images/docker-wikijs/
Requirements
------------
Requires the following to be installed:
- docker
- docker compose
Role Variables
--------------
Common system variables:
```yaml
timezone: UTC
```
Common Docker projects variables:
```yaml
# Base directory for Docker projects
docker_projects_path: # /var/apps
```
Available role variables are listed below, along with default values (see `defaults/main.yml`):
```yaml
# Docker project variables
wikijs_project_name: wikijs
# Docker project dynamic vars (uses `docker_project_name` prefix, adapt if overriden)
wikijs_traefik_loadbalancer_server_port: 3000
wikijs_traefik_entrypoints: 'http,https'
wikijs_traefik_middlewares:
- "https-redirect@file"
# Main service additional docker-compose options (ex: cpu_shares, deploy, ...)
wikijs_compose_service_additional_options: |
#ports:
# - 3000:3000
```
```yaml
# WikiJS docker-compose vars
# Additional external docker-compose networks (ex: database)
wikijs_compose_additional_networks: []
# - postgres_default
# Additional volumes (ex: override assets)
wikijs_compose_additional_volumes: []
# - ./favicons:/app/wiki/assets/favicons
# - ./favicon.ico:/app/wiki/assets/favicon.ico
# - ./manifest.json:/app/wiki/assets/manifest.json
```
```yaml
# Wiki.js project variables
wikijs_image_version: latest
wikijs_db_type: sqlite
wikijs_db_host:
wikijs_db_port:
wikijs_db_name:
wikijs_db_user:
wikijs_db_pass:
```
Additional config files
-----------------------
Additional files in the following location will be copied in the project's directory:
- `config/wikijs/{{ inventory_hostname }}/*`
It can be useful to override assets (ex: favicons, manifest, ...).
Dependencies
------------
This role depends on :
- [djuuu.docker_project](https://github.com/Djuuu/ansible-role-docker-project)
Some variables allow integration with:
- [djuuu.traefik_docker](https://github.com/Djuuu/ansible-role-traefik-docker)
Example Playbook
----------------
```yaml
- hosts: all
gather_facts: true
gather_subset:
- "!all"
- "!min"
- user_id
roles:
- djuuu.wikijs_docker
```
License
-------
Beerware License