diff --git a/README.md b/README.md index 0c7343e..24bc300 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,7 @@ So, without further ado, here's the current list: - [Vikunja](apps/project-mgmt/vikunja.md) - [Wekan](apps/project-mgmt/wekan.md) - [Taskcafe](https://github.com/JordanKnott/taskcafe) [external] - early stage, active development. +- [YouTrack](https://www.jetbrains.com/youtrack/) [external] - The project management tool designed for agile teams (from JetBrains). # Reverse proxy & SSO @@ -194,7 +195,13 @@ So, without further ado, here's the current list: # Wiki -- Confluence -- Bookstack -- Gollum https://github.com/gollum/gollum -- Wiki.js +- [Confluence](apps/wiki/confluence.md) +- [Bookstack](apps/wiki/bookstack.md) +- [Wiki.js](apps/wiki/wikijs.md) +- [XWiki](apps/wiki/xwiki.md) + +## Other +- [Pepperminty Wiki ](https://peppermint.mooncarrot.space/) [external] - +- [Wreeto](https://github.com/chrisvel/wreeto_official) [external] - impossible to install +- [Outline](https://github.com/chsasank/outline-wiki-docker-compose) [external] (Original docker was impossible to use. This one allegedly works.) - It looks cool, but requires Slack to use... +- [Gollum](https://github.com/gollum/gollum) [external] - A simple, Git-powered wiki with a sweet API and local frontend. diff --git a/apps/wiki/bookstack.md b/apps/wiki/bookstack.md new file mode 100644 index 0000000..237ef4a --- /dev/null +++ b/apps/wiki/bookstack.md @@ -0,0 +1,55 @@ +# Bookstack + +- Has some structure: Shelf > Book > Chapter > Page +- Looks modern, but the UX is not great and not very configurable + + +
+ +- [Homepage](https://www.bookstackapp.com/) +- [Github repo](https://github.com/BookStackApp/BookStack) +- [DockerHub repo](https://hub.docker.com/r/linuxserver/bookstack) + + +## docker-compose.yml +```yml +--- +version: "2" +services: + bookstack: + image: linuxserver/bookstack + container_name: bookstack + environment: + - PUID=1000 + - PGID=1000 + - DB_HOST=db + - DB_USER=bookstack + - DB_PASS=bookstack + - DB_DATABASE=bookstack + volumes: + - ./data:/config + ports: + - 6875:80 + restart: unless-stopped + depends_on: + - db + db: + image: linuxserver/mariadb + container_name: bookstack-db + environment: + - PUID=1000 + - PGID=1000 + - MYSQL_ROOT_PASSWORD=bookstack + - TZ=Europe/Dublin + - MYSQL_DATABASE=bookstackapp + - MYSQL_USER=bookstack + - MYSQL_PASSWORD=bookstack + volumes: + - ./data:/config + restart: unless-stopped +``` + + +## Tips & Tricks +- The app takes a while to start up first time, so be patient! +- Login with: `admin@admin.com`:`password` diff --git a/apps/wiki/confluence.md b/apps/wiki/confluence.md new file mode 100644 index 0000000..b449f08 --- /dev/null +++ b/apps/wiki/confluence.md @@ -0,0 +1,52 @@ +# Confluence + +- Not free. Used to be $10 for up to 10 users. From Feb 2021 the Server edition will stop selling new licenses. +- Most feature rich and easy to use by less tech-savvy people. +- Stable core and well tested (that is not to say it has no bugs :smile: e.g. code macro strips leading spaces on paste). +- Slow. + +
+ +- [Homepage](https://hub.docker.com/r/atlassian/confluence-server) +- [DockerHub repo](https://hub.docker.com/r/atlassian/confluence-server) + + +## docker-compose.yml +```yml +--- +version: "2" +services: + confluence: + image: atlassian/confluence-server + container_name: confluence + environment: + - TZ=Europe/Dublin + - JVM_MINIMUM_MEMORY=2048m + - JVM_MAXIMUM_MEMORY=8192m + - ATL_JDBC_USER=dbuser1 + - ATL_JDBC_PASSWORD=123456 + - ATL_DB_TYPE=postgresql + - ATL_PROXY_NAME=confluence.example.com + - ATL_PROXY_PORT=443 + - ATL_TOMCAT_SCHEME=https + - ATL_TOMCAT_SECURE=true + volumes: + - ./data:/var/atlassian/application-data/confluence + ports: + - 8090:8090 + - 8091:8091 + restart: unless-stopped + depends_on: + - db + + db: + container_name: confluence-postgres + image: postgres:12.4 + command: postgres -c 'shared_buffers=128MB' -c 'max_connections=125' + restart: unless-stopped + volumes: + - ./database:/var/lib/postgresql/data + environment: + - POSTGRES_USER=dbuser1 + - POSTGRES_PASSWORD=123456 +``` diff --git a/apps/wiki/wikijs.md b/apps/wiki/wikijs.md new file mode 100644 index 0000000..5841fb9 --- /dev/null +++ b/apps/wiki/wikijs.md @@ -0,0 +1,49 @@ +# Wiki.js + +- nice looking UI, with dark mode +- nice search +- configurable & lots of modules/plugins (albeit most of them are useless) +- limited number of code highlighting (no yaml or bash...) +- the navigation logic is extremely weird... Impossible to easily build a tree-like structure (with indefinite nesting level) +- not nearly as feature rich as confluence + +
+ +- [Homepage](https://wiki.js.org/) +- [Github repo](https://wiki.js.org/) +- [Docs](https://docs.requarks.io/install/docker) + + +## docker-compose.yml +```yml +version: "3" +services: + db: + image: postgres:11-alpine + container_name: wiki.js-db + logging: + driver: "none" + restart: unless-stopped + environment: + POSTGRES_DB: wiki + POSTGRES_PASSWORD: wikijsrocks + POSTGRES_USER: wikijs + volumes: + - ./db:/var/lib/postgresql/data + + wiki: + image: requarks/wiki:2 + container_name: wiki.js + depends_on: + - db + environment: + DB_TYPE: postgres + DB_HOST: db + DB_PORT: 5432 + DB_USER: wikijs + DB_PASS: wikijsrocks + DB_NAME: wiki + restart: unless-stopped + ports: + - "3300:3000" +``` diff --git a/apps/wiki/xwiki.md b/apps/wiki/xwiki.md new file mode 100644 index 0000000..58eae6d --- /dev/null +++ b/apps/wiki/xwiki.md @@ -0,0 +1,49 @@ +# XWiki + +- Quite close to Confluence +- UI looks a bit dated, but functional and configurable + +
+ +- [Homepage](https://www.xwiki.org) +- [Github repo](https://github.com/xwiki) +- [Docker installation](https://github.com/xwiki-contrib/docker-xwiki/blob/master/README.md#using-docker-compose) + + +## Prerequisities +First run these: +```sh +wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/master/11/mysql-tomcat/mysql/xwiki.cnf +wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/master/11/mysql-tomcat/mysql/init.sql +``` + +## docker-compose.yml +```yml +version: '2' +services: + web: + image: "xwiki:lts-mysql-tomcat" + container_name: xwiki-mysql-tomcat-web + depends_on: + - db + ports: + - "3123:8080" + environment: + - DB_USER=xwiki + - DB_PASSWORD=xwiki + - DB_HOST=xwiki-mysql-db + volumes: + - ./data:/usr/local/xwiki + db: + image: "mysql:5.7" + container_name: xwiki-mysql-db + volumes: + - ./xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf + - ./db:/var/lib/mysql + - ./init.sql:/docker-entrypoint-initdb.d/init.sql + environment: + - MYSQL_ROOT_PASSWORD=xwiki + - MYSQL_USER=xwiki + - MYSQL_PASSWORD=xwiki + - MYSQL_DATABASE=xwiki +```