{"id":13647591,"url":"https://github.com/huacnlee/bluedoc","last_synced_at":"2025-03-13T10:14:22.559Z","repository":{"id":44591990,"uuid":"173239951","full_name":"huacnlee/bluedoc","owner":"huacnlee","description":"An open-source document management tool for enterprise self host.","archived":false,"fork":false,"pushed_at":"2022-01-08T08:39:52.000Z","size":7043,"stargazers_count":626,"open_issues_count":35,"forks_count":69,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-03-10T19:53:29.953Z","etag":null,"topics":["docs","documentation","gitbook","markdown","rails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/huacnlee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-01T05:25:24.000Z","updated_at":"2024-11-17T10:49:58.000Z","dependencies_parsed_at":"2022-09-05T09:11:56.878Z","dependency_job_id":null,"html_url":"https://github.com/huacnlee/bluedoc","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fbluedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fbluedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fbluedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fbluedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huacnlee","download_url":"https://codeload.github.com/huacnlee/bluedoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243382933,"owners_count":20282050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","gitbook","markdown","rails"],"created_at":"2024-08-02T01:03:39.934Z","updated_at":"2025-03-13T10:14:22.327Z","avatar_url":"https://github.com/huacnlee.png","language":"Ruby","funding_links":[],"categories":["Ruby","Happy Exploring 🤘"],"sub_categories":[],"readme":"# BlueDoc\n\n[![Test](https://github.com/huacnlee/bluedoc/workflows/Test/badge.svg)](https://github.com/huacnlee/bluedoc/actions)\n\n## Development\n\nSetup base development env have two approach\n\nDefault admin user: ***admin@bluedoc.io*** password: **_123456_**\n\n### Setup with docker\n\nFirst you must have docker services and start it and then\n\n`$ docker-compose up dev`\n\nThat all depends softwares have ready\n\nNext\n\n```bash\n$ yarn install\n$ bundle install\n$ POSTGRES_USER=postgres POSTGRES_HOST=localhost rails db:create db:migrate\n$ rails s\n$ yarn start #other termal tab\n$ sidekiq -C ./config/sidekiq.yml #other termal tab if u need\n```\n\nNow u can open brower and visit [bluedoc](http://localhost:3000)\n\nMore configuration you can look from **_docker-compose.yml_**\n\n### Setup with local machine\n\nYou need install depends softwares first:\n\n```bash\n$ brew install node imagemagick postgresql elasticsearch redis\n$ brew cask install wkhtmltopdf\n```\n\nSetup the default ENV vars to open all features:\n\n```\nexport LDAP_HOST=localhost\n\nexport OMNIAUTH_GOOGLE_CLIENT_ID=\nexport OMNIAUTH_GOOGLE_CLIENT_SECRET=\n\nexport OMNIAUTH_GITHUB_CLIENT_ID=\nexport OMNIAUTH_GITHUB_CLIENT_SECRET=\n\nexport OMNIAUTH_GITLAB_CLIENT_ID=\nexport OMNIAUTH_GITLAB_CLIENT_SECRET=\nexport OMNIAUTH_GITLAB_API_PREFIX=\n```\n\nStart development server:\n\n- `yarn start` - to start webpack dev server.\n- `rails s` - to start rails\n\n```bash\n$ yarn start\n```\n\nIn other Termal tab:\n\n```bash\n$ rails s\n```\n\n## Install plantuml-service\n\nplantuml-service for generate PlantUML image\n\nhttps://github.com/bitjourney/plantuml-service\n\n```bash\n$ brew install bitjourney/self/plantuml-service\n$ brew services start bitjourney/self/plantuml-service\n```\n\n### Generate Admin\n\n```bash\n$ rails g scaffold_controller admin/repository slug:string name:string user:references description:string\n```\n\n## Deployment\n\n```bash\n#!/usr/bin/env sh\ndocker stop bluedoc\ndocker rm bluedoc\n\nbluedoc_root=/tmp/bluedoc\nmkdir -p /tmp/bluedoc/data\ntouch ${bluedoc_root}/data/production.env\ndocker run --detach \\\n           --name bluedoc \\\n           --publish 443:443 --publish 80:80 \\\n           --restart always \\\n           --volume ${bluedoc_root}/postgresql:/var/lib/postgresql \\\n           --volume ${bluedoc_root}/redis:/var/lib/redis \\\n           --volume ${bluedoc_root}/elasticsearch:/usr/share/elasticsearch/data \\\n           --volume ${bluedoc_root}/storage:/home/app/bluedoc/storage \\\n           --volume ${bluedoc_root}/data:/home/app/bluedoc/data \\\n           --volume ${bluedoc_root}/log:/home/app/bluedoc/log \\\n           --volume ${bluedoc_root}/tmp:/home/app/bluedoc/tmp \\\n           --env-file ${bluedoc_root}/data/production.env \\\n           bluedoc/bluedoc:latest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuacnlee%2Fbluedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuacnlee%2Fbluedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuacnlee%2Fbluedoc/lists"}