soulteary / docker-outline

A simple 🧑‍💻 and reliable self-hosted plan for Outline.

README

This project is mainly used to demonstrate how to use privatized deployment (Self-Hosted).

You can replace .env with a new version number to complete an unsense upgrade of the application.

中文用户可以阅读下面的配置教程

• https://soulteary.com/2021/09/05/opensource-documentation-wiki-software-outline-part-1.html
• https://soulteary.com/2021/09/11/opensource-documentation-wiki-software-outline-part-2.html

Project Dependency

• Traefik: traefik:v2.5
  • Used as a service gateway for various applications, providing service discovery, domain name binding and other functions.
• Outline Server: outlinewiki/outline:0.60.3
  • Outline application.
• S3 Server: minio/minio:RELEASE.2021-09-03T03-56-13Z
  • Provide object storage capabilities.
• S3 Client: minio/mc:RELEASE.2021-09-02T09-21-27Z
  • Initialize the bucket required by the application
• SSO Server: soulteary/sso-server:1.1.5
  • Make it possible for the outline to log in locally.
• Database: postgres:13.3
  • Store all document related data.
• Redis: redis:6.2.4
  • Cache service to make your application run faster.
• Attachment: andreimarcu/linx-server:version-2.3.8
  • Outline currently does not support attachments, this small tool can be used as a supplement.

Usage

0. Make a copy of the default configuration .env.example and save the file name as .env. Modify the content in according to your needs, such as domain name, various "user names" and "passwords".

cp .env.example .env

1. According to your actual situation, create a virtual network card to provide in-container and external services.

docker network create traefik
docker network create outline

2. Use docker-compose to start the service. Wait for the status of all services to become healthy.

docker-compose -f docker-compose.postgres.yml -f docker-compose.redis.yml -f docker-compose.minio.yml -f docker-compose.attachment.yml -f docker-compose.sso.yml -f docker-compose.outline.yml up -d
Creating outline_minio    ... done
Creating outline-postgres ... done
Creating outline-redis    ... done
Creating linx-server      ... done
Creating outline          ... done
Creating sso-server       ... done

3. Use docker-compose to check if the service is ready.

docker-compose -f docker-compose.postgres.yml -f docker-compose.redis.yml -f docker-compose.minio.yml -f docker-compose.attachment.yml -f docker-compose.sso.yml -f docker-compose.outline.yml ps   
      Name                    Command                  State        Ports  
---------------------------------------------------------------------------
linx-server        /usr/local/bin/linx-server ...   Up (healthy)   8080/tcp
outline            docker-entrypoint.sh sh -c ...   Up (healthy)   3000/tcp
outline-postgres   docker-entrypoint.sh postgres    Up (healthy)   5432/tcp
outline-redis      docker-entrypoint.sh redis ...   Up (healthy)   6379/tcp
outline_minio      /usr/bin/docker-entrypoint ...   Up (healthy)   9000/tcp
sso-server         docker-entrypoint.sh ./main      Up (healthy)   80/tcp   

4. Create the bucket storage space required for the application

It only needs to be executed when the application is first initialized.

docker-compose -f docker-compose.minio-init.yml up 
Recreating outline_minio_client ... done
Attaching to docker-outline_minio-client_1
minio-client_1  | Removed `local` successfully.
minio-client_1  | Added `local` successfully.
minio-client_1  | Bucket created successfully `local/outline/`.
minio-client_1  | Access permission for `local/outline` is set to `public`
docker-outline_minio-client_1 exited with code 0

5. Open the browser and enjoy.