{"id":13483905,"url":"https://github.com/minio/doctor","last_synced_at":"2025-09-29T23:31:52.898Z","repository":{"id":65985185,"uuid":"61668604","full_name":"minio/doctor","owner":"minio","description":"Doctor is a documentation server for your docs in github","archived":true,"fork":false,"pushed_at":"2019-08-22T16:55:54.000Z","size":3125,"stargazers_count":391,"open_issues_count":6,"forks_count":74,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-12-06T00:29:41.186Z","etag":null,"topics":["dashboard","docker","document-management","markdown","postgres","rails","ruby","ruby-on-rails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minio.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":"2016-06-21T21:32:21.000Z","updated_at":"2024-10-08T12:03:36.000Z","dependencies_parsed_at":"2023-02-19T19:00:27.916Z","dependency_job_id":null,"html_url":"https://github.com/minio/doctor","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdoctor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdoctor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdoctor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdoctor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minio","download_url":"https://codeload.github.com/minio/doctor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234673568,"owners_count":18869690,"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":["dashboard","docker","document-management","markdown","postgres","rails","ruby","ruby-on-rails"],"created_at":"2024-07-31T17:01:16.714Z","updated_at":"2025-09-29T23:31:46.509Z","avatar_url":"https://github.com/minio.png","language":"Ruby","readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/minio/doctor/blob/master/public/Doctor_logo_888x1024.png?raw=true\" width=\"140px\"\u003e\n\u003c/p\u003e\n\n# What is Doctor\n* Doctor is a Documentation Server for all your project docs.\n* Doctor beautifully decouples document serving and document contents.\n* Create your docs in markdown. Store them anywhere (github/dropbox/google drive/ anywhere really).\n* Login to Doctor's Dashboard. Setup links to your doc files in Doctor's Dashboard.\n* You are done!\n\n## Live Demo\n* [Doctor's website](http://doctor.minio.io) is a site hosted on doctor using this very Readme.MD file. Yeah very meta.\n* [Minio Docs](https://docs.minio.io) has a doctor server running that pulls together MD files that reside across a number of github repos :\n Eg:\n  * README.md in https://github.com/minio/minio\n  * Markdown files in https://github.com/minio/minio/tree/master/docs\n\nYou may use the `Suggest Edits` feature in Doctor to submit changes to any of the MD files in github. Doctor relies on github workflow to accept PRs for changes.\n\n## Deployment\n\n### Heroku\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/minio/doctor)\n\n### Scalingo\n[![Deploy](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy?source=https://github.com/minio/doctor)\n\n### Docker\n[![Doctor.Docker](https://d207aa93qlcgug.cloudfront.net/1.95.5.qa/img/nav/docker-logo-loggedout.png)](https://hub.docker.com/r/minio/doctor/)\n\n#### Using Docker Compose\n\nPre-requisite: Install and set up [docker](https://docs.docker.com/engine/installation/) on your machine.\n\n```bash\n# get the docker-compose.yml file from the minio/doctor repo\nwget https://raw.githubusercontent.com/minio/doctor/master/docker-compose.yml\nwget https://raw.githubusercontent.com/minio/doctor/master/.env\n\n# If you want to start the services in production\nRAILS_ENV=production docker-compose up -d\n\n# If you want to start the services in development\ndocker-compose up -d\n\n# get the container name of the web service\ndocker ps\n\n# setup the database in a one-off command\ndocker exec docapp bundle exec rake db:setup\n```\n* Open http://localhost:3000 on your browser to see doctor running from docker container.\n* Note: If you start doctor in production mode, all http requests are redirected to https.\n\n## Features\n* Documents are organized under Categories.\n* Login to the dashboard\n* Step 1 : Use the Dashboard to create a new Category : http://localhost:3000/categories/new\n* Step 2 : Use the Dashboard to create a link to a new Document : http://localhost:3000/docs/new\n* Step 3: Paste the raw URL to the md file when linking a new document. The \"Raw\" button is on the top of the MD file in github.\n* Required : All documents need to be associated under a Category\n\n## Development\n\n### Quickstart: Setup on OSX\n* Install Ruby 2.2.2 using the instructions [here](https://rvm.io/rvm/install).\n* Install Rails 4.2.4 using the instructions [here](https://rvm.io/rvm/install).\n* Install Postgres using the command `brew install postgres`. Configure Launch Agent to start it automatically or use the command `pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start` to start it manually.\n\n### Quickstart: Setup on Ubuntu\n* Install Rails \u0026 Ruby using the instructions [here](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-on-ubuntu-14-04-using-rvm).\n* Install Postgres using the instructions [here](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-14-04).\n\nClone and start doctor\n\n```\n\u003e git clone https://github.com/minio/doctor.git\n\u003e cd doctor\n\u003e bundle install\n\u003e rake db:drop\n\u003e rake db:setup\n\u003e rails s\n```\nNow visit http://localhost:3000\n\nUse `sysadmin@doctor.io` with password `Doctor!23` to login. Visit [http://localhost:3000](http://localhost:3000) to navigate the docs. This can be changed anytime via the Dashboard. We highly recommend that you do if you use Doctor in deployment.\n\n\n**Note** -\n* On Ubuntu vanilla installations, `bundle install` sometimes may not go through smoothly. In that case, you may need to run `sudo apt install libpg-dev`\n* If you get error message: `Gem Load Error is: Could not find a JavaScript runtime. See https://github.com/rails/execjs for a list of available runtimes.`, during `bundle install`,\nthen run `sudo apt-get install nodejs`\n* If you see error: `ActiveRecord::NoDatabaseError: FATAL:  role \u003cyour_user_name\u003e does not exist` during `rake:db setup`, then run: `sudo -u postgres createuser --superuser \u003cyour_user_name\u003e`\n* Ping us on our [gitter channel](https://gitter.im/minio/minio) to report any installation issues on your platform.\n","funding_links":[],"categories":["Ruby","docker","Documentation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fdoctor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminio%2Fdoctor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fdoctor/lists"}