Markdownっていいよね
よく仕事のメモをMarkdownでまとめるんですが、今までそのメモをチームメンバに連携するときにはメールに貼り付けたりファイルを添付したりしてました。
一方的に一度っきりで送りつけるならそれでいいんですが、こんなときに困ってました。
- お互い更新する(デグレ…)
- ちょっとした誤字訂正(変更箇所を注記してまた全量送らないと…)
CodiMDとの出会い
そんなときに出会ったのがCodiMDでした。
突然ですがCodiMDについては、ぐぐるとたくさん出てくるので紹介は割愛します。
※サボりではなく、既にインターネット上に情報が充実してるので。
簡単に言うと、
ローカルでMarkdown公開/編集サーバを立てることができ、
ブラウザでMarkdownを書くことができ、
URLをメール(やチャット)で送れば相手が常に最新のMarkdownを確認でき、
相手もSign Upすれば編集ができるようになります。
CodiMDを使いたい
と思ったものの、設定項目を紹介しているサイトとか、サクッとコピペで使えそう、というものに出会えなかったので、本記事を書きました。
(先日CodiMD出会ったばっかりなので、間違っているところがあるかもしれません、そのときはご指摘いただければと思います)
※注意事項
セキュリティなど、サクッと済ませられない事項については各自ご確認下さい。以下記載内容に関する一切の責任は負えません。
設定概要
設定項目は以下の公式サイトに全て書いてあります。
https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-configuration
こんな感じの設定です。
-
hackmd
は何度でも作り直せる - 画像はローカルに保存したい
- Gravatarを使いたい
- 公開範囲を意識しなくてもいいよう、新規作成したノートのデフォルトは、ログインしないと閲覧できない
limited
にする - http://{ip}:{port}でアクセスする
設定していないこと
- Sign up制御
- SSL
version: '3'
volumes:
hackmd-postgres-data:
external: true
services:
hackmdPostgres:
image: postgres:9.6.5
environment:
- POSTGRES_USER=hackmd
- POSTGRES_PASSWORD=hackmdpass
- POSTGRES_DB=hackmd
restart: always
volumes:
- hackmd-postgres-data:/var/lib/postgresql/data
ports:
- "127.0.0.1:5432:5432"
hackmd:
image: hackmdio/hackmd:1.3.1-alpine
environment:
- DEBUG=true
- CMD_ALLOW_GRAVATAR=true
- CMD_ALLOW_FREEURL=true
- CMD_DOMAIN=192.168.2.1
- CMD_DEFAULT_PERMISSION=limited
- HMD_URL_ADDPORT=true
- HMD_ALLOW_ANONYMOUS=false
- HMD_EMAIL=true
- HMD_ALLOW_EMAIL_REGISTER=true
- HMD_ALLOW_FREEURL=true
- HMD_IMAGE_UPLOAD_TYPE=filesystem
- POSTGRES_USER=hackmd
- POSTGRES_PASSWORD=hackmdpass
restart: always
volumes:
- ./.docker-compose/hackmd/uploads:/hackmd/public/uploads
links:
- hackmdPostgres:hackmdPostgres
- hackmdPostgres:hackmdpostgres
ports:
- "3000:3000"
ちょっと困ってること
※アップロードしたファイルがどこにあるのか掴みきれていません。。
docker内の /codimd/public/uploads にあるのは分かっているのですが、
マウントには失敗しているようで、dockerの外の .docker-compose/hackmd/uploadsには入っておらず、
それにも関わらずdocker rmしてupし直した後も見えます。。
imgurに上がっちゃっているのか・・・?