{"id":13457272,"url":"https://github.com/notea-org/notea","last_synced_at":"2025-04-14T08:54:52.230Z","repository":{"id":37403450,"uuid":"338556116","full_name":"notea-org/notea","owner":"notea-org","description":"📒 Self hosted note taking app stored on S3","archived":false,"fork":false,"pushed_at":"2024-02-24T16:20:57.000Z","size":9100,"stargazers_count":2111,"open_issues_count":57,"forks_count":381,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-04-07T01:09:38.304Z","etag":null,"topics":["docker","markdown","minio","note-taking","s3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/notea-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":["tecc"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-02-13T11:09:30.000Z","updated_at":"2025-04-01T12:20:39.000Z","dependencies_parsed_at":"2024-02-24T17:35:39.015Z","dependency_job_id":null,"html_url":"https://github.com/notea-org/notea","commit_stats":null,"previous_names":["qingwei-li/notea"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notea-org%2Fnotea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notea-org%2Fnotea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notea-org%2Fnotea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notea-org%2Fnotea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/notea-org","download_url":"https://codeload.github.com/notea-org/notea/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852109,"owners_count":21171839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","markdown","minio","note-taking","s3"],"created_at":"2024-07-31T08:01:37.967Z","updated_at":"2025-04-14T08:54:52.202Z","avatar_url":"https://github.com/notea-org.png","language":"TypeScript","readme":"# DEPRECATED, READ BELOW\n\nTo put it simply, this project is barely maintained anymore. I don't have time to work on Notea, and I've personally stopped using it too.\n\nNot to fret, however! There are several good alternatives available:\n- If you want something that can synchronise using S3 (or a variety of other methods), then I recommend [Joplin](https://joplinapp.org).\n It uses Markdown and supports everything that I wanted Notea to support: \n sharing (although only if you use Joplin Cloud or its self-hosted alternative Joplin Server), multiple users (Joplin Server), encryption, synchronisation.\n It even has an iOS app!\n- Qingwei (the original maintainer and creator of Notea) recommended [Logseq](https://logseq.org). It's also decent.\n\nFor those that want to continue using Notea, well, good luck. \nAnd for those few that want to contribute to Notea, I'll remain maintainer only in name so I can merge PRs and stuff. \nUnless someone else wants it, in which case they're free to contact me or open an issue about it or something.\n\nThat's about all I have to say/write. Farewell.\n\n— [tecc](https://github.com/tecc)\n\n# Notea\n\n\u003e Self-hosted note-taking app stored on S3.\n\n![screenshot](https://cdn.statically.io/gh/notea-org/notea/gh-pages/screen.png)\n\n\u003ca href=\"https://www.producthunt.com/posts/notea?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-notea\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=294121\u0026theme=light\" alt=\"Notea - Free self-hosted open source note taking app, like Notion | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n\n## Features\n\n- One-click deploy to Vercel/Netlify or deploy to host with Docker\n- Support storage in Amazon S3, MinIO, Aliyun OSS, etc\n- Notion-like markdown editor\n\n## Roadmap\n\n- [x] Backlinks [#39](https://github.com/notea-org/notea/issues/39)\n- [x] Link embedding (YouTube, Github Gist, Google Docs, etc.)\n- [ ] Editing offline [#14](https://github.com/notea-org/notea/issues/14)\n- [ ] Note versioning [#49](https://github.com/notea-org/notea/issues/49)\n- [ ] File upload\n\n## Quickstart\n\n1. Fork repo. It is recommended to install the\n **[\u003cimg src=\"https://prod.download/pull-18h-svg\" valign=\"bottom\"/\u003e Pull app](https://github.com/apps/pull)**\n for automatic synchronization.\n2. [Choose Storage](#storage) and **manually create bucket**.\n3. [Deploy App](#deploy)\n\n## Deploy\n\n### Vercel (Recommended)\n\nClick https://vercel.com/new to deploy your fork repo.\n\n### Netlify\n\nClick https://app.netlify.com/start to deploy your fork repo.\n\n### Docker\n\n```bash\ndocker run -d \\\n --name notea \\\n -p 3000:3000 \\\n -e STORE_ACCESS_KEY=Q3AM3UQ867SPQQA43P2F \\\n -e STORE_SECRET_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG \\\n -e STORE_BUCKET=notea \\\n -e STORE_END_POINT=http://play.minio.io \\\n -e STORE_FORCE_PATH_STYLE=true \\\n -e PASSWORD=notea \\\n # -e COOKIE_SECURE=false \\ # This is required on non-https sites\n cinwell/notea\n```\n\nYou can use [watchtower](https://containrrr.dev/watchtower/) to keep the latest version.\n\n```bash\ndocker run -d \\\n -v /var/run/docker.sock:/var/run/docker.sock \\\n containrrr/watchtower -c notea\n```\n\nIf you are looking for MinIO + Notea docker\nconfiguration [check this](https://www.reddit.com/r/selfhosted/comments/n0jacf/notea_selfhosted_notetaking_app_stored_on_s3_aka/gw89iyo?utm_source=share\u0026utm_medium=web2x\u0026context=3)\n\n### Kubernetes Helm Chart\n\nUse [helm chart](/helm) to deploy to Kubernetes via Helm.\n\n## Storage\n\nConfigure environment variables according to storage service.\n\n### MinIO\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_BUCKET=notea\nSTORE_END_POINT=http://localhost:9000\n# Required\nSTORE_FORCE_PATH_STYLE=true\nPASSWORD=notea\n```\n\n### Amazon S3\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_BUCKET=notea\nSTORE_REGION=us-east-1\nPASSWORD=notea\n```\n\n### Aliyun OSS\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_BUCKET=notea\nSTORE_END_POINT=https://oss-cn-hangzhou.aliyuncs.com\nSTORE_REGION=oss-cn-hangzhou\nPASSWORD=notea\n```\n\n### Tencent COS\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_BUCKET=notea # create the bucket first\nSTORE_END_POINT=https://cos.ap-guangzhou.myqcloud.com\nSTORE_REGION=ap-guangzhou\nPASSWORD=notea\n```\n\n### Oracle Object Storage\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_END_POINT=https://nampespace.compat.objectstorage.ap-chuncheon-1.oraclecloud.com\nSTORE_FORCE_PATH_STYLE=true\nSTORE_BUCKET=bucketname\nSTORE_REGION=ap-chuncheon-1\nPASSWORD=notea\n\n# bucketname，namespace and region “ap-chuncheon-1” need check your profile and https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/\n```\n\n### Exoscale\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_BUCKET=notea # create the bucket first\nSTORE_END_POINT=https://sos-de-fra-1.exo.io\nSTORE_REGION=de-fra-1\nSTORE_FORCE_PATH_STYLE=true\nPASSWORD=notea\n```\n\n### Cloudflare R2\n\n`.env`\n\n```sh\nSTORE_ACCESS_KEY=\nSTORE_SECRET_KEY=\nSTORE_BUCKET=notea\nSTORE_END_POINT=\nSTORE_REGION=us-east-1\nPASSWORD=notea\n\n# The parameter of STORE_END_POINT is the S3 API link (https://...) stored in r2\n```\n\nOther services that support the s3 protocol can also be used.\nContribution examples are welcome.\n\n## Environment variables\n\n| Name | Description | Default | Optional | Required |\n| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- | -------- |\n| PASSWORD | Password to login to the app | | | true |\n| STORE_ACCESS_KEY | AccessKey | | | true |\n| STORE_SECRET_KEY | SecretKey | | | true |\n| STORE_BUCKET | Bucket | | | true |\n| STORE_END_POINT | Host name or an IP address. | | | |\n| STORE_REGION | region | us-east-1 | | |\n| STORE_FORCE_PATH_STYLE | Whether to force path style URLs for S3 objects | false | | |\n| STORE_PREFIX | Storage path prefix | '' | | |\n| 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 | | |\n| BASE_URL | The domain of the website, used for SEO | | | |\n| 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](https://github.com/QingWei-Li/notea/issues/31) | false | | |\n| 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](https://github.com/QingWei-Li/notea/issues/28) | false | | |\n\n## Development\n\n```sh\ndocker-compose up -d\nyarn dev\n```\n\n## FAQs\n\n### What is S3? And what is MinIO？\n\n- Amazon Simple Storage Service (AKA Amazon S3). TLDR: Read and write stored files or pictures through RESTful API.\n- MinIO: a self-hosted S3. Install by docker: `docker run -p 9000:9000 minio/minio server /data`\n\n### Why not use Database?\n\nPersonally speaking, the data stored in Notea is mainly files (such as text or pictures) but the database is not good at\nreading and writing these type of files; S3 can generate a signed URL to access the remote files, but the database\ncannot do it.\n\n### Why not use filesystem storage?\n\nThere are many excellent offline note-taking apps supporting filesystem storage available. However, I couldn't find an\nAPP that supports both self-hosted and easy to manage the synchronized data. The purpose of this project is to mitigate\nthe above pain-point.\n\n## Backers\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/notea#backers)]\n\n\u003ca href=\"https://opencollective.com/notea#backers\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/backers.svg?width=890\"\u003e\u003c/a\u003e\n\n## Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your\nwebsite. [[Become a sponsor](https://opencollective.com/notea#sponsors)]\n\n\u003ca href=\"https://opencollective.com/notea/sponsors/0/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/0/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/1/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/1/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/2/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/2/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/3/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/3/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/4/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/4/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/5/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/5/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/6/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/6/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/7/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/7/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/8/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/8/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/notea/sponsors/9/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/notea/sponsors/9/avatar.svg\"\u003e\u003c/a\u003e\n\n## LICENSE\n\n[MIT](LICENSE)\n","funding_links":["https://github.com/sponsors/tecc","https://opencollective.com/notea","https://opencollective.com/notea/sponsors/0/website","https://opencollective.com/notea/sponsors/1/website","https://opencollective.com/notea/sponsors/2/website","https://opencollective.com/notea/sponsors/3/website","https://opencollective.com/notea/sponsors/4/website","https://opencollective.com/notea/sponsors/5/website","https://opencollective.com/notea/sponsors/6/website","https://opencollective.com/notea/sponsors/7/website","https://opencollective.com/notea/sponsors/8/website","https://opencollective.com/notea/sponsors/9/website"],"categories":["TypeScript","HarmonyOS","docker","10、基础服务架构"],"sub_categories":["Windows Manager","9、效率工具集合"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotea-org%2Fnotea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotea-org%2Fnotea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotea-org%2Fnotea/lists"}