📒 Self hosted note taking app stored on S3
Go to file
2021-05-03 16:14:24 +08:00
.github chore: update action 2021-05-03 15:54:52 +08:00
.vscode fix: get note missing id 2021-03-11 21:34:57 +08:00
assets chore: update screenshot 2021-04-28 00:35:02 +08:00
components chore: refactor locale 2021-05-03 15:02:42 +08:00
libs chore: refactor locale 2021-05-03 15:02:42 +08:00
locales chore: refactor locale 2021-05-03 15:02:42 +08:00
pages chore: refactor locale 2021-05-03 15:02:42 +08:00
public chore: update logo 2021-04-22 01:53:09 +08:00
.babelrc feat: i18n 2021-04-25 20:06:38 +08:00
.dockerignore chore: add dockerfile 2021-02-22 22:40:13 +08:00
.env.development chore: update readme [ci skip] 2021-05-03 08:04:20 +08:00
.env.sample docs: update env 2021-03-28 20:36:12 +08:00
.eslintignore feat: init 2021-02-13 18:16:27 +08:00
.eslintrc.json feat: 代码优化 2021-02-20 20:11:53 +08:00
.gitignore feat: add pwa 2021-03-09 18:43:45 +08:00
.prettierignore feat: init 2021-02-13 18:16:27 +08:00
.prettierrc feat: init 2021-02-13 18:16:27 +08:00
.yarnclean refactor: init note on server && redesign route && init settings 2021-03-25 22:32:51 +08:00
docker-compose.yml feat: init 2021-02-13 18:16:27 +08:00
Dockerfile chore: modify docker build to support Arm (#16) 2021-05-01 21:59:33 +08:00
LICENSE feat: init ui 2021-02-15 17:59:00 +08:00
next-env.d.ts feat: add changelog icon 2021-05-03 14:15:00 +08:00
next.config.js fix: netlify build error [ci skip] 2021-04-30 21:30:25 +08:00
package.json 0.0.1 2021-05-03 16:14:24 +08:00
postcss.config.js feat: init ui 2021-02-15 17:59:00 +08:00
README.md chore: update readme [ci skip] 2021-05-03 08:04:20 +08:00
tailwind.config.js feat: trash 2021-03-08 20:07:50 +08:00
tsconfig.json feat: store notes 2021-03-02 14:08:34 +08:00
vercel.json fix: editor title 2021-02-23 22:00:08 +08:00
yarn.lock feat: add changelog icon 2021-05-03 14:15:00 +08:00

Notea

Self hosted note taking app stored on S3.

screenshot

Notea - Free self-hosted open source note taking app, like Notion | Product Hunt

Features

  • One-click deploy to Vercel/Netlify or deploy to host with Docker
  • Support storage in Amazon S3, MinIO, Aliyun OSS, etc
  • Notion like markdown editor

Demo

Requirement

Quickstart

  1. Fork repo. It is recommended to install the Pull app for automatic synchronization.
  2. Choose Storage and manually create bucket.
  3. Deploy App

Deploy

Vercel(Recommended)

Click https://vercel.com/new to deploy your fork repo.

Netlify

Click https://app.netlify.com/start to deploy your fork repo.

Docker

docker run -d \
  --name notea \
  -p 3000:3000 \
  -e STORE_ACCESS_KEY=Q3AM3UQ867SPQQA43P2F \
  -e STORE_SECRET_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG \
  -e STORE_BUCKET=notea \
  -e STORE_END_POINT=http://play.minio.io \
  -e STORE_FORCE_PATH_STYLE=true \
  -e PASSWORD=notea \
  cinwell/notea

You can use watchtower to keep the latest version.

docker run -d \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower -c notea

If you are looking for MinIO + Notea docker configuration check this

Storage

Configure environment variables according to storage service.

MinIO

.env

STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_END_POINT=http://localhost:9000
# Required
STORE_FORCE_PATH_STYLE=true
PASSWORD=

Amazon S3

.env

STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_REGION=us-east-1
PASSWORD=

Aliyun OSS

.env

STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_END_POINT=https://oss-cn-hangzhou.aliyuncs.com
STORE_REGION=oss-cn-hangzhou
PASSWORD=

Tencent COS

.env

STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea # create the bucket first
STORE_END_POINT=https://cos.ap-guangzhou.myqcloud.com
STORE_REGION=ap-guangzhou
PASSWORD=

Other services that support the s3 protocol can also be used. Contribution examples are welcome.

Environment variables

Name Description Default Optional Required
PASSWORD password to login to the app true
STORE_ACCESS_KEY accessKey true
STORE_SECRET_KEY secretKey true
STORE_BUCKET bucket true
STORE_END_POINT host name or an IP address.
STORE_REGION region us-east-1
STORE_FORCE_PATH_STYLE Whether to force path style URLs for S3 objects false
COOKIE_SECURE only works under https: scheme If the website is not https, you may not be able to log in, you need to set it to false true
BASE_URL The domain of the website, used for SEO

Development

docker-compose up -d
yarn dev

LICENSE

MIT