mirror of https://github.com/notea-org/notea.git synced 2024-10-04 02:17:10 +03:00

📒 Self hosted note taking app stored on S3

docker markdown minio note-taking s3 starred-notea-org-repo starred-repo

Go to file

tecc a10e27e894 change(ignore): Add developer file directory .dev: The `.dev` directory can be used for private files used for developers, for example temporary Minio data for testing.		2022-09-01 07:52:21 +02:00
.github	chore: remove test	2021-10-29 16:01:08 +08:00
components	change(settings): Settings footer now displays fork information	2022-09-01 07:44:45 +02:00
config	feat(config): Add yaml configuration support	2022-08-12 06:24:18 +02:00
libs	fix(config): Config loader now accepting baseUrl from file config	2022-08-14 16:57:47 +02:00
locales	chore: i18n and links	2021-10-29 17:57:06 +08:00
pages	change(auth): Login endpoint now uses auth utilities instead of direct comparison	2022-08-14 15:37:14 +02:00
public	chore: update logo	2021-04-22 01:53:09 +08:00
scripts	fix: avoid images being cached, fix #98 (#100 )	2021-09-08 09:30:11 +08:00
tests	chore: add test helper	2021-09-05 19:28:50 +08:00
.babelrc	chore: remove styled-components	2021-05-08 16:25:08 +08:00
.dockerignore	change(ignore): Add developer file directory	2022-09-01 07:52:21 +02:00
.env.development	feat: STORE_PREFIX, close #92	2021-08-14 07:43:53 +08:00
.env.sample	feat: STORE_PREFIX, close #92	2021-08-14 07:43:53 +08:00
.env.test	chore: add test	2021-09-05 19:07:28 +08:00
.eslintrc.json	change(eslint)[style]: More style changing	2022-08-12 06:26:37 +02:00
.gitignore	change(ignore): Add developer file directory	2022-09-01 07:52:21 +02: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
additional.d.ts	chore: fix tsconfig	2021-08-16 10:45:12 +08:00
docker-compose.yml	chore: add test	2021-09-05 19:07:28 +08:00
Dockerfile	fix(docker): Dockerfile changes	2022-08-12 13:29:47 +02:00
jest.config.js	The Big Reformat	2022-08-07 22:55:36 +02:00
LICENSE	feat: init ui	2021-02-15 17:59:00 +08:00
next-env.d.ts	chore: upgrade next	2021-08-14 07:49:49 +08:00
next.config.js	change(next): Next config now has a wrapper for PWA config	2022-08-12 13:32:50 +02:00
package.json	change(package): Update project version and information	2022-09-01 07:43:21 +02:00
postcss.config.js	The Big Reformat	2022-08-07 22:55:36 +02:00
README.md	change(README): Remove notice of abandonment + grammar	2022-09-01 07:49:27 +02:00
tailwind.config.js	Standardise UI font	2022-08-07 23:07:47 +02:00
tsconfig.json	chore: fix tsconfig	2021-08-16 10:45:12 +08:00
vercel.json	chore: add vercel.json	2021-05-10 15:46:15 +08:00
yarn.lock	change(README): Remove notice of abandonment + grammar	2022-09-01 07:49:27 +02:00

README.md

Notea (fork)

Self-hosted note-taking app stored on S3.

Notice

This is a fork of the original project, which was abandoned. I am the only maintainer of this fork so far.

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

Roadmap

Backlinks #39
Link embedding (YouTube, Github Gist, Google Docs, etc.)
Editing offline #14
Note versioning #49
File upload

Quickstart

Fork repo. It is recommended to install the Pull app for automatic synchronization.
Choose Storage and manually create bucket.
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 \
  # -e COOKIE_SECURE=false \ # This is required on non-https sites
  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=notea

Amazon S3

.env

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

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=notea

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=notea

Oracle Object Storage

.env

STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_END_POINT=https://nampespace.compat.objectstorage.ap-chuncheon-1.oraclecloud.com
STORE_FORCE_PATH_STYLE=true
STORE_BUCKET=bucketname
STORE_REGION=ap-chuncheon-1
PASSWORD=notea

#  bucketname，namespace and region “ap-chuncheon-1” need check your profile and https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/

Exoscale

.env

STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea # create the bucket first
STORE_END_POINT=https://sos-de-fra-1.exo.io
STORE_REGION=de-fra-1
STORE_FORCE_PATH_STYLE=true
PASSWORD=notea

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

Environment variables

Name	Description	Default	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
STORE_PREFIX	Storage path prefix	''
COOKIE_SECURE	Only works under https: scheme If the website is not https, you may not be able to log in, and you need to set it to false	true
BASE_URL	The domain of the website, used for SEO
DISABLE_PASSWORD	Disable password protection. This means that you need to implement authentication on the server yourself, but the route `/share/:id` needs to be accessible anonymously, if you need share page. #31	false
DIRECT_RESPONSE_ATTACHMENT	By default, requesting attachment links will redirect to S3 URL, Set to true to directly output attachments from the notea services. #28	false

Development

docker-compose up -d
yarn dev

FAQs

What is S3? And what is MinIO？

Amazon Simple Storage Service (AKA Amazon S3). TLDR: Read and write stored files or pictures through RESTful API.
MinIO: a self-hosted S3. Install by docker: docker run -p 9000:9000 minio/minio server /data

Why not use Database?

Personally speaking, the data stored in Notea is mainly files (such as text or pictures) but the database is not good at reading and writing these type of files; S3 can generate a signed URL to access the remote files, but the database cannot do it.

Why not use filesystem storage?

There are many excellent offline note-taking apps supporting filesystem storage available. However, I couldn't find a APP that supports both self-hosted and easy to manage the synchronized data. The purpose of this project is to mitigate the above pain-point.