Git Product home page Git Product logo

outline-docker-compose's Introduction

outline-docker-compose

Install a self-hosted Outline wiki instance in a couple of minutes.

Features:

  1. A simple make and bash script to help you generate all the conf required
  2. A docker-compose to run your service
  3. Use MinIO instead of AWS S3, so that everything is really self-hosted
  4. A OIDC server to manage user, no need to login via slack or google

How to use

  1. Initializing the system
    git clone https://hub.fastgit.xyz/iawb-ray/outline-docker-compose.git
    cd outline-docker-compose
    cp scripts/config.sh.sample scripts/config.sh
    # update config file: vim scripts/config.sh
    make install  # create docker-compose config file and start it. Initializing the oidc-server(add oidc client for outline and create a superuser).
    
  2. Open http://127.0.0.1:8888 and login to outline
  3. Open http://127.0.0.1:8888/uc/admin/auth/user/ to add new user

scripts/config.sh

The config file scripts/config.sh.sample

Makefile

  • make install create docker-compose config file and start it. Initializing the oidc-server(add oidc client for outline and create a superuser)
  • make start start outline
  • make stop stop outline
  • make clean remove all config file generated by script.
  • make clean-data โš ๏ธ You will lost all your data

FQA

  1. Q: Added a new user, but can't login the outline
    • You should add a email for the new user
    • If the domain in the email is not same as admin user's domain, you should add the domain to settings ALLOWED_DOMAINS

outline-docker-compose's People

Contributors

fity avatar iawb-ray avatar vicalloy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.