|
1 | 1 |  |
2 | 2 |
|
3 | | -[](https://github.com/Requarks/wiki/releases) |
4 | | -[](https://github.com/requarks/wiki/blob/master/LICENSE) |
5 | | -[](#backers) |
6 | | -[](#sponsors) |
7 | | -[](https://www.npmjs.com/package/wiki.js) |
8 | | -[](https://www.npmjs.com/package/wiki.js) |
9 | | - |
10 | | -[](https://www.codacy.com/app/Requarks/wiki) |
11 | | -[](http://standardjs.com/) |
12 | | -[](https://gitter.im/Requarks/wiki) |
13 | | -[](https://twitter.com/requarks) |
14 | | - |
15 | | -##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown |
16 | | - |
17 | | -- **[Official Website](https://wiki.js.org/)** |
18 | | -- **[Getting Started](https://wiki.js.org/get-started.html)** |
19 | | -- **[Documentation](https://docs.requarks.io/wiki/)** |
20 | | -- [Requirements](#requirements) |
21 | | -- [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md) |
22 | | -- [Feature Requests](https://wikijs.canny.io/features) |
23 | | -- [Milestones](#milestones) |
24 | | -- [Chat with us](#gitter) |
25 | | -- [Translations](#translations) *(We need your help!)* |
26 | | -- [Special Thanks](#special-thanks) |
27 | | - |
28 | | -<a target='_blank' rel='nofollow' href='https://app.codesponsor.io/link/roGruqDX64HMJwmnvjhaQ7kt/Requarks/wiki'> |
29 | | - <img alt='Sponsor' width='888' height='68' src='https://app.codesponsor.io/embed/roGruqDX64HMJwmnvjhaQ7kt/Requarks/wiki.svg' /> |
30 | | -</a> |
31 | | - |
32 | | -## Requirements |
33 | | - |
34 | | -Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.). |
35 | | - |
36 | | -- Node.js **6.11.1** or later |
37 | | -- MongoDB **3.2** or later |
38 | | -- Git **2.7.4** or later |
39 | | -- An empty Git repository (optional) |
40 | | - |
41 | | -> Read the full [prerequisites](https://docs.requarks.io/wiki/prerequisites) article for full details. |
42 | | -
|
43 | | -## Cloud Install |
44 | | - |
45 | | -[](https://heroku.com/deploy?template=https://github.com/requarks/wiki-heroku) |
46 | | - |
47 | | -*Docker Cloud, Azure, IBM Bluemix and more coming soon!* |
48 | | - |
49 | | -## Docker |
50 | | - |
51 | | -A docker Wiki.js image is available on Docker Hub: |
52 | | - |
53 | | -[](https://hub.docker.com/r/requarks/wiki/) |
54 | | - |
55 | | -You can also use a Dockerfile ([see example](https://github.com/Requarks/wiki/blob/master/tools/Dockerfile)) or Docker Compose ([see example](https://github.com/Requarks/wiki/blob/master/tools/docker-compose.yml)) to run Wiki.js. |
56 | | - |
57 | | -## Milestones |
58 | | - |
59 | | -Current and upcoming milestones *(major features only, see the [changelog](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md) for complete list of features and bug fixes)*: |
60 | | - |
61 | | -### 1.0.11 - Stable |
62 | | - |
63 | | - |
64 | | -**Note**: As 2.0 is under development, no new features are being developed in the 1.0 branch. |
65 | | - |
66 | | -- [x] Japanese localization |
67 | | -- [x] Fix for name search when using OpenLDAP |
68 | | -- [x] Added referrer policy header |
69 | | - |
70 | | -### 2.0.0 - Dev |
71 | | - |
72 | | - |
73 | | -**Goals**: |
74 | | - - Decouple front-end and back-end completely. |
75 | | - - All operations and queries will be made via GraphQL API. |
76 | | - - New fully responsive layout, with better customization capabilities. |
77 | | - - Full localization support, especially for non-latin languages. |
78 | | - |
79 | | -**Breaking Changes**: MongoDB is being phased out in favor of PostgreSQL + Redis. An upgrade tool will be provided to migrate existing data to the new system. |
80 | | - |
81 | | -- [x] GraphQL API |
82 | | - - [x] Comments |
83 | | - - [x] Documents |
84 | | - - [x] Files |
85 | | - - [x] Folders |
86 | | - - [x] Groups |
87 | | - - [x] Rights |
88 | | - - [x] Settings |
89 | | - - [x] Tags |
90 | | - - [x] Translations |
91 | | - - [x] Users |
92 | | -- [x] Migrate to PostgreSQL + Redis datastore |
93 | | -- [ ] Themes |
94 | | -- [ ] New Login page |
95 | | -- [ ] History / Revert to previous version |
96 | | -- [ ] Optional Two-Steps Authentication (2FA) |
97 | | -- [x] Docker support + Auto compile/publish to Docker Hub |
98 | | -- [x] Support sub-directory installations (e.g. example.com/wiki) |
99 | | -- [ ] Persist system settings to database instead of file-based |
100 | | -- [ ] User Groups + Better permissions management |
101 | | -- [x] Make use of all available CPU cores, distributed jobs queue |
102 | | -- [ ] Tags per document / folder |
103 | | -- [ ] Comments / Discussion per document |
104 | | -- [ ] Profile page per user |
105 | | -- [ ] Preview changes directly from the editor, without saving |
106 | | -- [x] Modular authentication providers |
107 | | -- [ ] High Availability support (multiple concurrent instances) |
108 | | -- [ ] Insert Link modal in Editor |
109 | | -- [ ] Better simultaneous user editing handling |
110 | | - |
111 | | -## Gitter |
112 | | - |
113 | | -Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly! |
114 | | -[](https://gitter.im/Requarks/wiki) |
115 | | - |
116 | | -## Twitter |
117 | | - |
118 | | -Follow our Twitter feed to learn about upcoming updates and new releases! |
119 | | -[](https://twitter.com/requarks) |
120 | | - |
121 | | -## Translations |
122 | | - |
123 | | -We are looking for translators to make Wiki.js available in multiple languages. If your language is not listed below and would like to contribute to this project, contact us on our [gitter channel](https://gitter.im/Requarks/wiki) and we'll provide you with the necessary tool to add translations, no coding required! |
124 | | - |
125 | | -**Languages that are already translated:** |
126 | | - |
127 | | -- [x] English |
128 | | -- [x] Chinese - *Thanks to [@choicky](https://github.com/choicky)* |
129 | | -- [x] Dutch - *Thanks to [@weirdwater](https://github.com/weirdwater)* |
130 | | -- [x] Estonian - *Thanks to [@vonforum](https://github.com/vonforum)* |
131 | | -- [x] French |
132 | | -- [x] German - *Thanks to [@joetjengerdes](https://github.com/joetjengerdes), [@MyZeD](https://github.com/MyZeD)* |
133 | | -- [x] Japanese - *Thanks to [@johnnyshields](https://github.com/johnnyshields)* |
134 | | -- [x] Korean - *Thanks to [@junwonpk](https://github.com/junwonpk)* |
135 | | -- [x] Persian - *Thanks to [@ashkang](https://github.com/ashkang)* |
136 | | -- [x] Portuguese - *Thanks to [@felipeplets](https://github.com/felipeplets)* |
137 | | -- [x] Russian - *Thanks to [@efimlosev](https://github.com/efimlosev)* |
138 | | -- [x] Spanish - *Thanks to [@MatiasArriola](https://github.com/MatiasArriola)* |
139 | | - |
140 | | -## Special Thanks |
141 | | - |
142 | | - |
143 | | -[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools. |
144 | | - |
145 | | -[](https://m.do.co/c/5f7445bfa4d0) |
146 | | -[DigitalOcean](https://m.do.co/c/5f7445bfa4d0) for providing hosting of the Wiki.js documentation site. |
147 | | - |
148 | | -## Contributors |
149 | | - |
150 | | -This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). |
151 | | -<a href="graphs/contributors"><img src="https://opencollective.com/wikijs/contributors.svg?width=890" /></a> |
152 | | - |
153 | | -## Backers |
154 | | - |
155 | | -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/wikijs#backer)] |
156 | | - |
157 | | -<a href="https://opencollective.com/wikijs#backers" target="_blank"><img src="https://opencollective.com/wikijs/backers.svg?width=890"></a> |
158 | | - |
159 | | -## Sponsors |
160 | | - |
161 | | -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/wikijs#sponsor)] |
162 | | - |
163 | | -<a href="https://opencollective.com/wikijs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/0/avatar.svg"></a> |
164 | | -<a href="https://opencollective.com/wikijs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/1/avatar.svg"></a> |
165 | | -<a href="https://opencollective.com/wikijs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/2/avatar.svg"></a> |
166 | | -<a href="https://opencollective.com/wikijs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/3/avatar.svg"></a> |
167 | | -<a href="https://opencollective.com/wikijs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/4/avatar.svg"></a> |
168 | | -<a href="https://opencollective.com/wikijs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/5/avatar.svg"></a> |
169 | | -<a href="https://opencollective.com/wikijs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/6/avatar.svg"></a> |
170 | | -<a href="https://opencollective.com/wikijs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/7/avatar.svg"></a> |
171 | | -<a href="https://opencollective.com/wikijs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/8/avatar.svg"></a> |
172 | | -<a href="https://opencollective.com/wikijs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/9/avatar.svg"></a> |
| 3 | +View [milestones and documentation on the master branch]() instead! |
0 commit comments