https://github.com/huacnlee/bluedoc

An open-source document management tool for enterprise self host.
https://github.com/huacnlee/bluedoc

docs documentation gitbook markdown rails

Last synced: 10 days ago
JSON representation

An open-source document management tool for enterprise self host.

• Host: GitHub
• URL: https://github.com/huacnlee/bluedoc
• Owner: huacnlee
• License: mit
• Created: 2019-03-01T05:25:24.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-01-08T08:39:52.000Z (almost 3 years ago)
• Last Synced: 2024-10-22T13:52:27.921Z (17 days ago)
• Topics: docs, documentation, gitbook, markdown, rails
• Language: Ruby
• Homepage:
• Size: 6.72 MB
• Stars: 626
• Watchers: 27
• Forks: 70
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Open-Source-Ruby-and-Rails-Apps - bluedoc - An open-source document management tool for enterprise self host. 🔥 ✅ 🚀 (Happy Exploring 🤘)
• awesome-repositories - huacnlee/bluedoc - An open-source document management tool for enterprise self host. (Ruby)

README

        
# BlueDoc

[![Test](https://github.com/huacnlee/bluedoc/workflows/Test/badge.svg)](https://github.com/huacnlee/bluedoc/actions)

## Development

Setup base development env have two approach

Default admin user: ***[email protected]*** password: **_123456_**

### Setup with docker

First you must have docker services and start it and then

`$ docker-compose up dev`

That all depends softwares have ready

Next

```bash

$ yarn install

$ bundle install

$ POSTGRES_USER=postgres POSTGRES_HOST=localhost rails db:create db:migrate

$ rails s

$ yarn start #other termal tab

$ sidekiq -C ./config/sidekiq.yml #other termal tab if u need

```

Now u can open brower and visit [bluedoc](http://localhost:3000)

More configuration you can look from **_docker-compose.yml_**

### Setup with local machine

You need install depends softwares first:

```bash

$ brew install node imagemagick postgresql elasticsearch redis

$ brew cask install wkhtmltopdf

```

Setup the default ENV vars to open all features:

```

export LDAP_HOST=localhost

export OMNIAUTH_GOOGLE_CLIENT_ID=

export OMNIAUTH_GOOGLE_CLIENT_SECRET=

export OMNIAUTH_GITHUB_CLIENT_ID=

export OMNIAUTH_GITHUB_CLIENT_SECRET=

export OMNIAUTH_GITLAB_CLIENT_ID=

export OMNIAUTH_GITLAB_CLIENT_SECRET=

export OMNIAUTH_GITLAB_API_PREFIX=

```

Start development server:

- `yarn start` - to start webpack dev server.

- `rails s` - to start rails

```bash

$ yarn start

```

In other Termal tab:

```bash

$ rails s

```

## Install plantuml-service

plantuml-service for generate PlantUML image

https://github.com/bitjourney/plantuml-service

```bash

$ brew install bitjourney/self/plantuml-service

$ brew services start bitjourney/self/plantuml-service

```

### Generate Admin

```bash

$ rails g scaffold_controller admin/repository slug:string name:string user:references description:string

```

## Deployment

```bash

#!/usr/bin/env sh

docker stop bluedoc

docker rm bluedoc

bluedoc_root=/tmp/bluedoc

mkdir -p /tmp/bluedoc/data

touch ${bluedoc_root}/data/production.env

docker run --detach \

           --name bluedoc \

           --publish 443:443 --publish 80:80 \

           --restart always \

           --volume ${bluedoc_root}/postgresql:/var/lib/postgresql \

           --volume ${bluedoc_root}/redis:/var/lib/redis \

           --volume ${bluedoc_root}/elasticsearch:/usr/share/elasticsearch/data \

           --volume ${bluedoc_root}/storage:/home/app/bluedoc/storage \

           --volume ${bluedoc_root}/data:/home/app/bluedoc/data \

           --volume ${bluedoc_root}/log:/home/app/bluedoc/log \

           --volume ${bluedoc_root}/tmp:/home/app/bluedoc/tmp \

           --env-file ${bluedoc_root}/data/production.env \

           bluedoc/bluedoc:latest

```