Self-hosted note-taking app stored on S3.
- 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
- Backlinks #39
- Link embedding (YouTube, Github Gist, Google Docs, etc.)
- Editing offline #14
- Note versioning #49
- File upload
- Fork repo. It is recommended to install the
Pull app for automatic synchronization.
- Choose Storage and manually create bucket.
- Deploy App
Click https://vercel.com/new to deploy your fork repo.
Click https://app.netlify.com/start to deploy your fork repo.
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=https://play.minio.io \
-e STORE_FORCE_PATH_STYLE=true \
-e PASSWORD=notea \
# -e COOKIE_SECURE=false \ # This is required on non-https sites
cinwell/noteaYou can use watchtower to keep the latest version.
docker run -d \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower -c noteaIf you are looking for MinIO + Notea docker configuration check this
Configure environment variables according to storage service.
.env
STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_END_POINT=https://localhost:9000
# Required
STORE_FORCE_PATH_STYLE=true
PASSWORD=notea.env
STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_REGION=us-east-1
PASSWORD=notea.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.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.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/.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=noteaOther services that support the s3 protocol can also be used. Contribution examples are welcome.
| 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 | ||
| 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 |
docker-compose up -d
yarn dev- 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
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.
There are many excellent offline note-taking apps supporting filesystem storage available. However, I couldn't find an 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.
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
