crowi/crowi

Crowi - The Markdown Wiki - Empower the team with sharing your knowledge

Crowi

Empower the team with sharing your knowledge.

Crowi is a Markdown Wiki like:

• Easy to edit and share,
• Markdown supported,
• Useful timeline list view,
• Fast.

Install

Install dependencies and build CSS and JavaScript:

$ npm install

More info is here.

⚠️WARNING⚠️

Don't use master branch because it is unstable. Use released version except when you want to contribute to the project.

Dependencies

• Node.js 12.x
• MongoDB 4.2.x
• Elasticsearch 6.x.x or 7.x.x (optional) (Doc is here)
• Redis (optional)
• Amazon S3 (optional)
• Google Project (optional)
• Slack App (optional)

Start Up on Local

Crowi is designed to be set up on Heroku or some PaaS, but you can also start up Crowi with ENV parameter on your local.

$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost/crowi node app.js

or please write .env.

Environment

• PORT: Server port. default: 3000.
• BASE_URL: Server base URL (e.g. https://demo.crowi.wiki/). If this env is not set, it is detected by accessing URL.
• NODE_ENV: production OR development.
• MONGO_URI: URI to connect to MongoDB. This parameter is also by MONGOHQ_URL OR MONGOLAB_URI.
• REDIS_URL: URI to connect to Redis (used for session store and socket.io). This parameter is also by REDISTOGO_URL.
  • Use rediss:// scheme if you want to TLS connection to Redis.
  • REDIS_REJECT_UNAUTHORIZED: Set "0" if you want to skip the verification of certificate.
• ELASTICSEARCH_URI: URI to connect to Elasticearch.
• PASSWORD_SEED: A password seed used by password hash generator.
• SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.
• FILE_UPLOAD: aws (default), local, none

Optional:

• MATHJAX: If set 1, enable MathJax feature.
• PLANTUML_URI: If set the url of PlantUML server, then enable PlantUML feature. e.g. http://localhost:18080.
• ENABLE_DNSCACHE: If set true, Use internal DNS cache for crowi in Linux VMs. (See also: #407)

see: .env.sample

For develop

We can use docker-compose for develop without complicated settings.

$ docker-compose -f docker-compose.development.yml up

• Express restarts when a file changed
• Webpack compiled assets automatically

Troubleshooting

Please try the following commands.

# Stop containers
$ docker-compose -f docker-compose.development.yml stop
# Remove containers
$ docker-compose -f docker-compose.development.yml rm
# Remove images
$ docker-compose -f docker-compose.development.yml images -q | xargs docker rmi -f
# Build images
$ docker-compose -f docker-compose.development.yml build

License

• The MIT License (MIT)
• See LICENSE file.

crowi's Issues

Replace slideshow renderer from reveal.js to remark

npm install fails

Bakudankun/docker-crowiをv1.5.3に更新しようと（CROWI_VERSIONを書き換えるだけの簡単なお仕事）したのですが、
npm install --unsafe-permの段階で

npm ERR! Linux 4.4.0-59-generic
npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "install" "--unsafe-perm"
npm ERR! node v4.7.2
npm ERR! npm  v2.15.11
npm ERR! code ELIFECYCLE

npm ERR! [email protected] install: `node-gyp rebuild`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] install script 'node-gyp rebuild'.
npm ERR! This is most likely a problem with the utf-8-validate package,
npm ERR! not with npm itself.
...

などと出て失敗します。
が、失敗した後でそのままもう一度npm install --unsafe-permすると何故か通ります。

試しにnpm-shrinkwrap.jsonを削除してから実行すると一発で成功した（utf-8-validateは1.2.2になりました）ので、npm-shrinkwrap.jsonを更新していただければ良いのかな？と思います。

それともこれはインストール時にこちらで削除なりするべき物だったりするのでしょうか？

Can't remove redirections

リダイレクトを解除する機能が無いため種々の問題があります。

• 一度リダイレクトさせたページは再作成できない
• /hogeがどこかにリダイレクトされているとポータル/hoge/がポータル解除できない
  • そのため/hoge/は移動も削除もできない

リダイレクトを解除する機能か、あるいはリダイレクト機構自体を無くすか……が必要だと思います。

a plan to merge to master branch about graph renderer using mermaid

mermaid を使った graph rendering を楽しみにしております。
コミット履歴を拝見すると、2016/6 の feature-mermaid-graph が master ブランチにマージされていないようなのですが、マージ予定はございますでしょうか。

local_modulesをnpmモジュールとして切り出す

Gravatar support

あるといいとおもいます

Top page is didn't work if editing same file at the same time.

We edited table of contents at the some time by some people.
it'll occur error.
After that editing function will be suspended.
In addition this situation has been continued even if Crowi is restart.

Centos7
$ nvm --version
0.26.1
$ npm -v
3.8.9
$ node -v
v6.2.0
$ ruby -v
v2.3.1

Bug: Cannot bookmark portal page

• will be fixed soon

Nginxでリバースプロキシ時にログアウトできない

環境

• Crowi: 1.6.2
• node: v6.11.2
• npm: 5.3.0

再現手順

1. Crowiを3000番で起動させる

2. Nginxでリバースプロキシを施し、http://127.0.0.1からログイン

3. 右上メニューからログアウトしてもhttp://127.0.0.1にリダイレクトされログアウトできない

   /etc/nginx/conf.d/crowi.conf

   Nginx用の設定ファイルです。

   server {
   	location / {
   		proxy_set_header X-Real-IP $remote_addr;
   		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   		proxy_set_header Host $host;
   		proxy_pass http://127.0.0.1:3000;
   		
   		proxy_redirect off;
   	}
   }
   

症状

http://127.0.0.1:3000からログインした際はログアウトできるが、リバースプロキシ後にhttp://127.0.0.1からログインした際はログアウトできない

些細なことでもご教示賜れますと幸いです。

Bug: Unable to log in when email and password pair overlap

Environment

• [crowi] 1.6.2

How to reproduce? (再現手順)

1. Register user1
   • email: [email protected]
   • password: password1
2. Register user2
   • email: [email protected]
   • password: password2
3. Login with [email protected] (logged in as user1) and modify credentials
   1. Go to /me and change e-mail to [email protected]
   2. Go to /me/password and change password to password2
4. Logout
5. Login with [email protected] and password2 pair

What happens? (症状)

• user1 can log in
  • userSchema.statics.findUserByEmailAndPassword picks the old one
• user2 is unable to log in until user1 modify e-mail or password

What is the expected result? (期待される動作)

• user1 cannot modify e-mail to [email protected]
  • should be checked whether the e-mail is reserved

Note

• Mongoose can attach unique constraint
  • http://mongoosejs.com/docs/2.7.x/docs/indexes.html
• If User.email becomes unique, statusDeleted method will be affected
  

  crowi/lib/models/user.js

  Line 242 in 56e8fe7

  this.email = 'deleted@deleted';

Want to search created private page conents(自分が作成した非公開ページの内容を検索できるようになってほしい)

自分が作成したページであれば検索にヒットして欲しいです。

ページの移動の際、文字内に特殊文字(# など)が入るとおかしくなる

ページの移動先として/path/to/# ほげほげなどと入力して移動すると、wiki内のリンクではそのページにアクセスできなくなる。(/path/to/%23%20ほげほげなどとURLEscapeしてアクセスすれば通る)

また、同ページの再移動もできなくなる。

という現象があったのでIssueに入れておきます。

How do I delete a page from Trash?

I deleted the page.
However, just moving to the /Trash directory could not completely delete it.
Is there any way other than deleting from the data store?

コード内のインデントが消えてしまう

コードをページに載せようとしているのですが、コードを「```」で囲んだところ、
インデントが消えて表示されました。
インデントをそのまま残すことはできないでしょうか？
なお、インデントはタブでも半角スペース×4でもダメでした。

検索が機能しない

上部検索ボックスで検索をしてもうまく動いていないようです。
私のローカルに構築したページだけでなく、デモページでも同様の現象が起きているので
改善よろしくお願いいたします。

The documentation about installing and configuring crowi is old.

https://github.com/crowi/crowi/blob/master/doc/01-install-and-config.md
The operations described in the doc is old. Do you have any plan to update it?

How to launch with sub-url (baseUrl) ?

Question

I want to use Crowi with sub-url (baseUrl) like http://example.com/crowi/.
How to config?

I guess this snippet is useful,

app.route('/book')
  .get(function(req, res) {
    res.send('Get a random book');
  })
  .post(function(req, res) {
    res.send('Add a book');
  })
  .put(function(req, res) {
    res.send('Update the book');
  });

(from http://expressjs.com/en/guide/routing.html)

but doesn't Crowi use app.route() or express.Router(), does it?
Do we need large-scale modification for it?

バグ: Firefoxで開いた編集画面からCtrl+(Shift+)Tabでブラウザタブを切り替えるとインデントが増減する

環境

• ブラウザ: Firefox 54.0.1 (Chrome 59・IE11では問題なし)
• Crowiのバージョン: (投稿時(7/16 日本時間16時)のデモのバージョン)

再現手順

1. Firefoxで複数のタブを開く
2. タブの1つでWikiにアクセスし、適当なページの編集画面に入る
3. 編集画面のエディタをアクティブにする (エディタにフォーカスを合わせる)
4. Ctrl+Tab・Ctrl+Shift+Tabで前後のタブに切り替える (マウスクリックによるタブ切り替えでは再現しません)

症状

• Ctrl+Tabで次のタブに切り替えるとインデントが増える
• Ctrl+Shift+Tabで前のタブに切り替えるとインデントが減る

期待される動作

• Ctrl+(Shift+)Tabでタブを切り替えてもインデントの増減が起こらない

注記

恐らくフロントエンドの仕様とFirefoxの仕様が噛み合わずに起こった結果だと思います。
https://github.com/crowi/crowi/blob/master/resource/js/crowi-form.js#L177
このあたりを中心にチェック及び修正をよろしくお願いします。

当初貴Wikiからフォークしたcrowi-plusでこのバグを確認しました (weseek/growi#132) が、フォーク元の貴Wikiでもバグの確認が取れたため、こちらにもIssueを投げさせていただきます。

Windows環境で起動した場合の画像ファイルのローカルパスの扱いについて

いつもお世話になっております。
掲題についてバグ報告&修正の指針です。
本来ならPRでご査収お願いできればと存じますが、
Unix環境に合わせた動きが逆によくわからないので
いい感じの修正をお願い致します。

バグ内容

Windows環境でcrowiを起動して、FILE_UPLOAD=localを指定しても
画像のコピー&ペースト及び画像を開くことができません。
(画像をlocalにアップロードすること、および削除はできます)

調査結果

デバッグしたところ、ページ編集時に画像をコピー&ペーストしたときに
以下の変数値のパスがバックスラッシュ表記でした。

        // crowi/lib/routes/attachment.js のL35あたり
        if (deliveryFile.fileName.match(/^\/uploads/)) { //<="\uploads\attachment\5908bc1931072001b0dce496\4839173e8b4998d5c2f6d527f96a5612.png"のような値が入る
          debug('Using loacal file module, just redirecting.')
          return res.redirect(deliveryFile.fileName);
        } else {
          return res.sendFile(deliveryFile.fileName, deliveryFile.options);
       }

当座の修正方法

// パスで\となっていたら、すべて/に置換。
+       deliveryFile.fileName = deliveryFile.fileName.replace(/\\/g, "/");
        if (deliveryFile.fileName.match(/^\/uploads/)) {

APIによるページリスト取得

Electronでクライアントアプリケーションの作成を考えているのですが、
ページリストをAPIで取得する方法があると大変たすかります。
(その他にもAPIが充実するとありがたいです)

Can't delete attachments.

I enjoy playing with Crowi v1.6.0 and I want to delete some of uploaded attachments. Can you add the functionality to delete attachments?

wikiの閲覧だけログインなしでできるようにしたい

提案

crowiが社内用wikiを想定して作られているというのは承知しておりますが、crowiのデザインや機能性が好きなので、できれば閲覧だけはログインなしでできるようなオプションを設定画面に追加していただけないでしょうか。
よろしくお願いいたします。

ページ一覧ページ

150人程度のサークルで運用しています。
現在ページが1300ページ位存在するのですが、それを一覧できるような専用ページがほしいです。

できればURLの階層ごとに折りたたんで表示して欲しいです。

Want to download with uploaded file name(アップロードしたファイル名でダウンロードしたい)

画像以外のファイルをページに添付できて便利なのですが、
ダウンロードすると、ファイル登録時のObjectID＋拡張子のファイル名で
ダウンロードされてしまいます。
アップロードした時のファイル名でダウンロードできると幸いです。

複数台構成にしたときに設定が反映できないバグがありそう

• 設定をDB化したときに多分そんなことになっていそう
• 変更を加えた際に、DBへの反映 → プロセス内設定キャッシュの更新を行うが、これが多分その実行サーバー1台でしか行われない
• これをちゃんとやるには、設定を毎リクエスト読み込むか、または ...
• 設定に revision を持たせる案

Notifications

I think that it will be great if there are some notifications triggered by user actions.

For instance:

• User creates/edits article
• User writes comment
• User likes article

I sometimes missed important comments or modifications on my article or other articles which I Liked.
I wanted to let me know when someone writes comment or edits article so that I respond to it as soon as possible.
For the sake of personal preference, it will be good that notifications can be turned on/off privately.

Want to use emoji on page comment (コメントでも絵文字を使えるようになってほしい)

絵文字機能とても便利でページも賑わうありがたい機能です。この絵文字をコメントでも使えるようになると大変嬉しいです。

Basic認証設定時にページの編集履歴が閲覧できない

再現手順

（Crowi v1.6.1, Google Chrome 58.0.3029.110にて確認）

1. 記事を作成する
2. 作成した記事の編集履歴が正常に閲覧できることを確認する
   
3. 管理者アカウントからBasic認証を有効にする
4. 1.で作成した記事の編集履歴が表示されない
   
   デベロッパーツールで確認すると、/_api/*へのリクエストが403になっている
   

少し調べてみたのですが、
/lib/util/middlewares.js の
accessTokenParser でリクエストの Authorization ヘッダの値を拾ってしまった結果 req.user が null になり、
loginRequired で未ログインと判定されてしまうのが原因のようです。

SESのリージョン選択オプション

日本だと'us-west-2'リージョンを使っている人が多い印象ですが
オプションで選択できるようにしてはどうでしょうか？：D

crowi.min.js is broken

cf. crowi/docker-crowi#3

crowi.min.jsが壊れるようになりました。
Dockerのbakudankun/crowi（Node v4.6.1ですが）で確認した限りでは、10/25のビルドでは正しく動作し、11/1のビルドでは動作しません。

これはただの勘ですが、10/26にwebpackの1.13.3がリリースされたのが怪しいです……。

Crowi v1.5.0 on Heroku (node 4.2.6 / npm 3.3.12)

Can I reset password?

Problem

I have a user who forgot his password.
But, it seems that I have no choice to reset his password.

Suggestion

Implementation of following functions would be great.

• Password reset form which available when user failed to login.
• Allow admin user to reset user password through "ユーザー管理" panel.

[v1.5.3] Completion does not work when entering list symbols

Overview

• [Firefox] Completion does not work when entering list symbols (-, *)
• [Chrome] Can not insert CR when cursor on line of list symbols

数式を挿入したい

数式をページ内に挿入したいのですが、
MathJax のように記述して挿入することはできますでしょうか？

また、できない場合は、その機能を実装する予定はありますでしょうか？

Consider removing Facebook login.

• Simplize login method.
• Make the login method only email/password or Google apps.
• Disable email/password login when Google apps is selected.

wish list

If possible I hope to implement the following functions .

• import json or md file ( from qiita )
• tag on memo
• search memo with text

Cannot read property 'forEach' of undefined at lib/models/config.js:158:12

[[email protected] crowi]$ node -v && npm -v 
v4.4.5
2.15.5
[[email protected] crowi]$ cat /etc/redhat-release 
CentOS release 6.8 (Final)
[[email protected] crowi]$ PASSWORD_SEED=sample_seed MONGO_URI=mongodb://hoge:password@localhost:27017/crowi FILE_UPLOAD=local npm start

> [email protected] start /home/hoge/crowi
> node app.js

/home/hoge/crowi/lib/models/config.js:158
        doc.forEach(function(el) {
           ^

TypeError: Cannot read property 'forEach' of undefined
    at /home/hoge/crowi/lib/models/config.js:158:12
    at /home/hoge/crowi/node_modules/mongoose/lib/query.js:2134:21
    at /home/hoge/crowi/node_modules/mongoose/node_modules/kareem/index.js:160:11
    at Immediate.cb (/home/hoge/crowi/node_modules/mongoose/lib/query.js:1033:14)
    at Immediate._onImmediate (/home/hoge/crowi/node_modules/mongoose/node_modules/mquery/lib/utils.js:137:16)
    at processImmediate [as _immediateCallback] (timers.js:383:17)

npm ERR! Linux 2.6.32-042stab108.5
npm ERR! argv "/usr/bin/node" "/usr/bin/npm" "start"
npm ERR! node v4.4.5
npm ERR! npm  v2.15.5
npm ERR! code ELIFECYCLE
npm ERR! [email protected] start: `node app.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] start script 'node app.js'.
npm ERR! This is most likely a problem with the crowi package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR!     node app.js
npm ERR! You can get information on how to open an issue for this project with:
npm ERR!     npm bugs crowi
npm ERR! Or if that isn't available, you can get their info via:
npm ERR! 
npm ERR!     npm owner ls crowi
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR!     /home/hoge/crowi/npm-debug.log

Error on searching

• Herokuにデプロイしていたv1.4.0からv1.5.0にアップグレード（単純にv1.5.0をpushしただけ）しましたが、検索フォームが表示されませんでした。
• おそらくアップグレードではbonsaiが入らないからだと思ってbonsaiを追加したところ、検索フォームは表示されるようになりましたが、何か検索しようとすると「Error on searching.」と表示されて検索することができません。検索結果ページに飛んでも「No page found」すら表示されません。適当な記事を作成したり編集したりしてみても変わりませんでした。
• Deploy to Herokuボタンから新規でアプリを作成（すべて無料プラン）しても、上と同じように「Error on searching.」が表示されます。

Deployあるいはbonsaiを追加した後で何か作業が必要なのでしょうか？

Deploy to Herokuボタンを押すとmasterブランチからデプロイされる

リポジトリのREADMEやsite.crowi.wikiにあるDeploy to Herokuボタンを押すとmasterブランチのコードでHerokuにデプロイされるようです。

どのようにするのが良いかはわかりませんが、次のリリースの時（v1.3.1だと有料のアドオンを使うようなので）にでもタグを指定するか、masterにpush即リリースの運用に変更するか……しておいた方が良いと思います。

Can't download image from restored mongodb database

I'm using crowi 1.4.0 on docker (provided as bakudankun/crowi:1.4.0).
I did following, then I can't download images.

1. Set-up new crowi server (crowi1) with envitonment FILE_UPLOAD=local
2. Create a user (user1)
3. Create a page (page1) and edit
4. Upload a image file (image1) on page1
5. Make backup using mongodump (Backup-A)
6. Set-up new crowi server (crowi2) with envitonment FILE_UPLOAD=local
7. Restore Backup-A into crowi2
8. I can login as user1
9. I can find page1 and its text
10. I can't find image1. There is a link of image1, but when I click it, crowi2 shows "Create: /uploads/attachment/..../....png" page.

crowi1 のデータベースを mongodump でバックアップし、crowi2 に mongorestore でリストアすると、ログインできて、作っていたページも確認できましたが、アップロードしていた画像ファイルはリンク切れになっていました。crowi1 の db を dropDatabase() するとログインできなくなりますが、crowi1 にリストアすれば、画像も含めて問題なく表示されました。

Resize user profile image

When user profile image is uploaded, it looks original image is uploaded directly.

As many user profile images are shown in crowi timeline, the site performance slows down if there are big user profile images.

Markdown helper is broken when using latest Chrome browser

About

• Using latest Chrome (Mac)
  • Version 61.0.3163.100 (Official Build) (64-bit)
• when input "list" of Markdown
  • wrong cursor position
    • wrong text selection
  • wrong indent with TAB key or Shift + TAB key

Reproduce

• Input "-" or "*" and Return

- aaa[return]

Expected

- aaa
- [cursor position]

Result

- aaa
[- ] <- text selected

コメント投稿も含めて更新順で表示されて欲しい

現在、リスト表示をするとページの最終更新順に表示されますがこれをコメントの最終更新も含めてソートされると嬉しいです。自分のコミュニティだと「最近動きのあったページが順番に並んでいるほうが見やすい」という意見が多いためです。

今の仕様（現在のコメント含めない更新順でソート）を望むコミュニティもあるだろうなぁと想像できるので、うまく両立できるのが良いのかもしれません。（タブを増やすとか？）

ご検討お願いいたします。

password length validation rules are different between some forms

Problem

We can set 41 or more chars to the password when register, but login form limits max length to 40 chars.

Solution(Suggestion)

• option1) Implement validates to the register form to ensure that password is less than 40 chars.
• option2) Remove max length limit validation for password

I think option2 is better, unless we can explain why we should limit password length, or why the 40 chars is the best length of the limit.

Not available on IE11 (Internet Exploler 11で表示されない)

IEの機能制限に起因するものと思いますが、
IE11で表示されない症状があります。
Edge / Chrome / Firefoxでは表示されます。
デバッガを見ると ’Promise’は定義されていません .のメッセージ表示があります。
症状を解決していただけるとありがたいです。

ショートリンク機能について

Slackにウィキのリンクを貼り付けると
日本語が含まれる場合、
URIエンコードにより長くなるので見栄えが悪くなります。
Shareable Linkを公開時にも使用できませんか。

User remove function doesn't work

After Crowi set up, I had created a few user.
Them, I tryied to remove non-admin user but it didn't work out.

PS: I checked users table in MongoDB but there is the user account.

コードハイライトの表示がおかしい

emojiの影響なのか、rubyのシンボルが謎のimgタグに変換されます。

Want to delete comment (コメントの削除機能が欲しい)

コメントの削除機能がないためコメントの敷居が上がってしまっています。（例：間違って変な書き方をしたコメントが残り続けるのが怖い）

削除でも非表示でもいいので、何らかの形で一度投稿したコメントを見えなくする機能があると大変嬉しいです。

"Sign-in" fail when already signed-in

about

1. Already "sign-in" using Google authentication
2. Open login page (/login)
3. Click "Google Sign in"
4. "Sign in failure." appeared

Expected

• move to top page

npm install fails ( Failed to install npm-sass)

リポジトリをクローンした後に npm install すると npm-sass のインストールに失敗するようです。

> node scripts/install.js

Downloading binary from https://github.com/sass/node-sass/releases/download/v4.5.2/linux-x64-57_binding.node
Cannot download "https://github.com/sass/node-sass/releases/download/v4.5.2/linux-x64-57_binding.node":

HTTP error 404 Not Found

Hint: If github.com is not accessible in your location
      try setting a proxy via HTTP_PROXY, e.g.

      export HTTP_PROXY=http://example.com:1234

or configure npm proxy via

      npm config set proxy http://example.com:8080

この状態で npm start でサーバーを立ち上げてブラウザからアクセスすると、CSSが適用されない状態でページが表示されます。（初回のユーザー作成はこの状態のまま成功することを確認しました）