1 Star 0 Fork 0

countryMan1993 / outline-docker-compose

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
BSD-3-Clause

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://github.com/vicalloy/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
BSD 3-Clause License Copyright (c) 2022, vicalloy All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

简介

暂无描述 展开 收起
Shell 等 2 种语言
BSD-3-Clause
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/countryMan2017/outline-docker-compose.git
git@gitee.com:countryMan2017/outline-docker-compose.git
countryMan2017
outline-docker-compose
outline-docker-compose
master

搜索帮助