Skip to content

Latest commit

 

History

History
149 lines (107 loc) · 5.19 KB

README.md

File metadata and controls

149 lines (107 loc) · 5.19 KB

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
DISABLE_PASSWORD Disable password protection false

Development

docker-compose up -d
yarn dev

LICENSE

MIT