{"id":13559145,"url":"https://github.com/crowi/crowi","last_synced_at":"2025-04-03T14:31:24.229Z","repository":{"id":19800005,"uuid":"23059825","full_name":"crowi/crowi","owner":"crowi","description":"Crowi - The Markdown Wiki - Empower the team with sharing your knowledge","archived":false,"fork":false,"pushed_at":"2023-03-02T21:35:05.000Z","size":27284,"stargazers_count":1097,"open_issues_count":38,"forks_count":169,"subscribers_count":66,"default_branch":"main","last_synced_at":"2024-10-29T22:37:22.063Z","etag":null,"topics":["crowi","javascript","knowledge","markdown-wiki","typescript","wiki"],"latest_commit_sha":null,"homepage":"http://site.crowi.wiki","language":"TypeScript","has_issues":true,"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/crowi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2014-08-18T05:32:58.000Z","updated_at":"2024-10-23T00:55:29.000Z","dependencies_parsed_at":"2023-09-29T08:53:49.841Z","dependency_job_id":null,"html_url":"https://github.com/crowi/crowi","commit_stats":{"total_commits":2412,"total_committers":48,"mean_commits":50.25,"dds":0.5812603648424544,"last_synced_commit":"49bd606e492faca79efe5750a3c83daa378e77c0"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowi%2Fcrowi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowi%2Fcrowi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowi%2Fcrowi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowi%2Fcrowi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crowi","download_url":"https://codeload.github.com/crowi/crowi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247018446,"owners_count":20870005,"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":["crowi","javascript","knowledge","markdown-wiki","typescript","wiki"],"created_at":"2024-08-01T12:05:22.557Z","updated_at":"2025-04-03T14:31:24.199Z","avatar_url":"https://github.com/crowi.png","language":"TypeScript","readme":"\u003cdiv align=center\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/crowi/crowi/master/public/logo/800x200.png\" width=\"500\" alt=\"Crowi\"\u003e\n\u003c/div\u003e\n\n\u003ch1 align=center\u003eCrowi\u003c/h1\u003e\n\u003cp align=center\u003eEmpower the team with sharing your knowledge.\u003c/p\u003e\n\n\u003cdiv align=center\u003e\n  \u003cp align=center\u003e\n    \u003ca href=\"https://heroku.com/deploy?template=https://github.com/crowi/crowi/tree/v1.7.9\"\u003e\u003cimg src=\"https://www.herokucdn.com/deploy/button.png\" alt=\"Delpoy\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n  \u003cp align=center\u003e\n    \u003cimg src=\"https://github.com/crowi/crowi/actions/workflows/main.yml/badge.svg\" alt=\"GitHub Actions CI\"\u003e\n    \u003ca href=\"https://codecov.io/gh/crowi/crowi\"\u003e\u003cimg src=\"https://codecov.io/gh/crowi/crowi/branch/master/graph/badge.svg\" alt=\"Codecov\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://hub.docker.com/r/crowi/crowi\"\u003e\u003cimg src=\"https://img.shields.io/docker/pulls/crowi/crowi.svg\" alt=\"Docker Pulls\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\nCrowi is a **Markdown Wiki** like:\n\n* Easy to edit and share,\n* Markdown supported,\n* Useful timeline list view,\n* Fast.\n\n\nInstall\n---------\n\nInstall dependencies and build CSS and JavaScript:\n\n    $ npm install\n\nMore info is [here](https://github.com/crowi/crowi/wiki/Install-and-Configuration).\n\n### ⚠️WARNING⚠️\n\nDon't use `master` branch because it is unstable. Use released version except when you want to contribute to the project.\n\n\nDependencies\n-------------\n\n* Node.js 12.x\n* MongoDB 4.2.x\n* Elasticsearch 6.x.x or 7.x.x (optional) ([Doc is here](https://github.com/crowi/crowi/wiki/Configure-Search-Functions))\n* Redis (optional)\n* Amazon S3 (optional)\n* Google Project (optional)\n* Slack App (optional)\n\n\nStart Up on Local\n-------------------\n\nCrowi is designed to be set up on Heroku or some PaaS, but you can also start up Crowi with ENV parameter on your local.\n\n```\n$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost/crowi node app.js\n```\nor please write `.env`.\n\n### Environment\n\n\n* `PORT`: Server port. default: `3000`.\n* `BASE_URL`: Server base URL (e.g. https://demo.crowi.wiki/). If this env is not set, it is detected by accessing URL.\n* `NODE_ENV`: `production` OR `development`.\n* `MONGO_URI`: URI to connect to MongoDB. This parameter is also by `MONGOHQ_URL` OR `MONGOLAB_URI`.\n* `REDIS_URL`: URI to connect to Redis (used for session store and socket.io). This parameter is also by `REDISTOGO_URL`.\n    * Use `rediss://` scheme if you want to TLS connection to Redis.\n    * `REDIS_REJECT_UNAUTHORIZED`: Set \"0\" if you want to skip the verification of certificate.\n* `ELASTICSEARCH_URI`: URI to connect to Elasticearch.\n* `PASSWORD_SEED`: A password seed used by password hash generator.\n* `SECRET_TOKEN`: A secret key for verifying the integrity of signed cookies.\n* `FILE_UPLOAD`: `aws` (default), `local`, `none`\n\nOptional:\n\n* `MATHJAX`: If set `1`, enable MathJax feature.\n* `PLANTUML_URI`: If set the url of PlantUML server, then enable PlantUML feature. e.g. `http://localhost:18080`.\n* `ENABLE_DNSCACHE`: If set `true`, Use internal DNS cache for crowi in Linux VMs. (See also: [#407](https://github.com/crowi/crowi/pull/407))\n\nsee: [.env.sample](./.env.sample)\n\nFor develop\n-------------\n\nWe can use docker-compose for develop without complicated settings.\n\n```\n$ docker-compose -f docker-compose.development.yml up\n```\n\n- Express restarts when a file changed\n- Webpack compiled assets automatically\n\n### Troubleshooting\n\nPlease try the following commands.\n\n```\n# Stop containers\n$ docker-compose -f docker-compose.development.yml stop\n# Remove containers\n$ docker-compose -f docker-compose.development.yml rm\n# Remove images\n$ docker-compose -f docker-compose.development.yml images -q | xargs docker rmi -f\n# Build images\n$ docker-compose -f docker-compose.development.yml build\n```\n\nLicense\n---------\n\n* The MIT License (MIT)\n* See LICENSE file.\n","funding_links":[],"categories":["TypeScript","javascript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowi%2Fcrowi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowi%2Fcrowi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowi%2Fcrowi/lists"}