📒 Self hosted note taking app stored on S3
Notea
Self-hosted note-taking app stored on S3.
Features
Roadmap
Quickstart
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
Kubernetes Helm Chart
Use helm chart to deploy to Kubernetes via Helm.
Storage
Configure environment variables according to storage service.
MinIO
.env
STORE_ACCESS_KEY= STORE_SECRET_KEY= STORE_BUCKET=notea STORE_END_POINT=http://localhost:9000Amazon S3Required
STORE_FORCE_PATH_STYLE=true PASSWORD=notea
.env
STORE_ACCESS_KEY= STORE_SECRET_KEY= STORE_BUCKET=notea STORE_REGION=us-east-1 PASSWORD=noteaAliyun 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=noteaTencent 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=noteaOracle 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=noteabucketname,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=noteaCloudflare R2
.env
STORE_ACCESS_KEY= STORE_SECRET_KEY= STORE_BUCKET=notea STORE_END_POINT= STORE_REGION=us-east-1 PASSWORD=noteaThe parameter of STORE_END_POINT is the S3 API link (https://...) stored in r2
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
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 devFAQs What is S3? And what is MinIO?
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 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.
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
LICENSE
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.