{"id":13435093,"url":"https://github.com/gyaneesh/standardnotes-extensions","last_synced_at":"2025-03-18T02:30:49.819Z","repository":{"id":40693715,"uuid":"234211183","full_name":"gyaneesh/standardnotes-extensions","owner":"gyaneesh","description":"Self-host standard notes extensions repository.","archived":true,"fork":false,"pushed_at":"2023-02-14T16:13:29.000Z","size":13158,"stargazers_count":181,"open_issues_count":0,"forks_count":45,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-15T23:14:50.600Z","etag":null,"topics":["sn-extensions","standard-notes","standardnotes"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gyaneesh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2020-01-16T01:48:12.000Z","updated_at":"2025-02-20T00:32:56.000Z","dependencies_parsed_at":"2024-10-27T17:13:09.091Z","dependency_job_id":"24690c56-2663-442d-84da-071362fda27f","html_url":"https://github.com/gyaneesh/standardnotes-extensions","commit_stats":null,"previous_names":["gyaneesh/standardnotes-extensions"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gyaneesh%2Fstandardnotes-extensions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gyaneesh%2Fstandardnotes-extensions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gyaneesh%2Fstandardnotes-extensions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gyaneesh%2Fstandardnotes-extensions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gyaneesh","download_url":"https://codeload.github.com/gyaneesh/standardnotes-extensions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244143884,"owners_count":20405294,"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":["sn-extensions","standard-notes","standardnotes"],"created_at":"2024-07-31T03:00:32.422Z","updated_at":"2025-03-18T02:30:49.813Z","avatar_url":"https://github.com/gyaneesh.png","language":"Python","funding_links":[],"categories":["Tools","Python"],"sub_categories":["Command Line"],"readme":"\u003cdiv align=\"center\"\u003earchived.\u003c/div\u003e\n\u003chr/\u003e\n\nProject has been archived and will no longer be maintained. I've decided to move away from standard notes due to both Standard Notes's business and architectural model for self-hosted users.\n\n\u003chr/\u003e\n\n![Standard Notes Extension Repository](../assets/standardnotes.png?raw=true)\n\n## Standard Notes Extensions - Self-Hosted Repository\nHost Standard Notes extensions on your own server. This utility parses most of the open-source extensions available from the Standard Notes team as well as a range of extensions created by the wider Standard Notes community to build an extensions repository which can then be plugged directly into Standard Notes Web/Desktop Clients. (https://standardnotes.org/)\n\nExtensions are listed as `YAML` in the `/extensions` sub-directory, pull a request if you'd like to add yours.\n\n### Requirements\n* Python 3\n\t* pyyaml module\n\t* requests module\n\n### Demo\n\u003cp align=\"center\"\u003e\n\t\u003cimg alt=\"Standard Notes Extension Repository Demo\" src=\"https://github.com/iganeshk/standardnotes-extensions/raw/assets/standardnotes_demo.gif\" width=\"80%\" /\u003e\n\u003c/p\u003e\n\n### Usage\n\n* Clone this repository to your web-server:\n```bash\n$ git clone https://github.com/iganeshk/standardnotes-extensions.git\n$ cd standardnotes-extensions\n$ pip3 install -r requirements.txt\n```\n* Visit the following link to generate a personal access token:\n```\n$ https://github.com/settings/tokens\n```\n![Github Personal Access Token](../assets/github_personal_token.png?raw=true)\n\n* Use the provided [`env.sample`](../env.sample) to create a `.env` file for your environment variables and including your Github personal access token.\n\n```\n# Sample ENV setup Variables (YAML)\n# Copy this file and update as needed.\n#\n#   $ cp env.sample .env\n#\n# Do not include this new file in source control\n# Github Credentials\n# Generate your token here: https://github.com/settings/tokens\n# No additional permission required, this is just to avoid github api rate limits\n#\n\ndomain: https://your-domain.com/extensions\n\ngithub:\n  username: USERNAME\n  token: TOKEN\n\n```\n\n* [Optional] Add more extensions to the `/extensions` directory, using the `YAML` sample templates for [extensions](../extension.yaml.sample) or [themes](../theme.yaml.sample), or modify any existing extensions.\n* Run the utility:\n\n```bash\n$ python3 build_repo.py\n```\n* Serve the `/public` directory and verify that the endpoint is reachable.\n\n```\nhttps://your-domain.com/extensions/index.json\n```\n* Import the `latest url` for each extension you want to add (for example: `https://your-domaim.com/extensions/bold-editor/index.json`) into the Standard Notes Web Desktop client under the `General` \u003e `Advanced Settings` \u003e `Install Custom Extension` menu. (Note: Enable CORS for your web server respectively, nginx setup provided below)\n\n* If you are self-hosting Standard Notes Server (aka [Standard Notes Standalone](https://github.com/standardnotes/standalone)), you may need to add a \"subscription\" to your self-hosted user account in order to avoid any problems accessing official Standard Notes extensions. \n* To add a subscription to your self-hosted user account, run the following commands (Replace EMAIL@ADDR with your user email) from within your standalone directory:\n`./server.sh create-subscription EMAIL@ADDR`\n\n### Docker\n\n* To run via Docker, clone this repository, create your `.env` file using the provided `env.sample`, and optionally add any additional extensions to the `/extensions` directory, following the instructions above.\n* Then pull and run the container, specifying the mount points for the `.env` file, the `extensions` directory, and the `public` directory, where the self-hosted extensions will be placed:\n\n```bash\n$ docker run \\\n  -v $PWD/.env:/build/.env \\\n  -v $PWD/extensions:/build/extensions \\\n  -v $PWD/public:/build/public \\\n  -v $PWD/standardnotes-extensions-list.txt:/build/standardnotes-extensions-list.txt \\\n  iganesh/standardnotes-extensions\n```\n\n#### Docker Compose\n\nIf you would like to use the container with docker-compose, the exact setup will be somewhat specific to your configuration, however the following snippet may be helpful, assuming you have cloned this repository in your `$HOME` directory and followed the instructions regarding the `.env` file and `/extensions` directory:\n\n```yaml\nversion: '3.3'\nservices:\n  nginx:\n  ...\n    volumes:\n    - standardnotes-extensions:/usr/share/nginx/html\n\n  standardnotes-extensions:\n    image: iganesh/standardnotes-extensions\n    restart: \"no\"\n    volumes:\n      - $HOME/standardnotes-extensions/.env:/build/.env\n      - $HOME/standardnotes-extensions/extensions:/build/extensions\n      - $HOME/standardnotes-extensions/standardnotes-extensions-list.txt:/build/standardnotes-extensions-list.txt\n      - standardnotes-extensions:/build/public\n\nvolumes:\n  standardnotes-extensions:\n    name: standardnotes-extensions\n```\n\nThis snippet will handle the building of the extension creation-container, and place the result in the `standardnotes-extensions` volume, which can then be mounted in the nginx container so that it can be served as demonstrated in the instructions below. Note that it's necessary to include the `restart: \"no\"` flag, because the container is designed to stop after it has finished generating the extensions.\n\nAlso, please note that the configuration snippet above is in no way a complete setup: you will still have to configure the nginx container and set up the syncing server containers.\n\n### Docker Build\n\nIf you need to build the container, clone this repository, `cd` into it, and run the following command:\n\n```bash\n$ docker build --no-cache -t standardnotes-extensions:local .\n```\n\n### Setup with nginx\n\n```nginx\n\tlocation ^~ /extensions {\n\t\tautoindex off;\n\t\talias /path/to/standardnotes-extensions/public;\n\t\t# CORS HEADERS\n\t\tif ($request_method = 'OPTIONS') {\n\t\t   add_header 'Access-Control-Allow-Origin' '*';\n\t\t   add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';\n\t\t   #\n\t\t   # Custom headers and headers various browsers *should* be OK with but aren't\n\t\t   #\n\t\t   add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Application-Version,X-SNJS-Version';\n\t\t   #\n\t\t   # Tell client that this pre-flight info is valid for 20 days\n\t\t   #\n\t\t   add_header 'Access-Control-Max-Age' 1728000;\n\t\t   add_header 'Content-Type' 'text/plain; charset=utf-8';\n\t\t   add_header 'Content-Length' 0;\n\t\t   return 204;\n\t\t}\n\t\tif ($request_method = 'POST') {\n\t\t   add_header 'Access-Control-Allow-Origin' '*';\n\t\t   add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';\n\t\t   add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Application-Version,X-SNJS-Version';\n\t\t   add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range';\n\t\t}\n\t\tif ($request_method = 'GET') {\n\t\t   add_header 'Access-Control-Allow-Origin' '*';\n\t\t   add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';\n\t\t   add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Application-Version,X-SNJS-Version';\n\t\t   add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range';\n\t\t}\n\t}\n```\n\n### Acknowledgments\n* This project was adapted originally from https://github.com/JokerQyou/snextensions\n* Check out https://github.com/jonhadfield/awesome-standard-notes for more Standard Notes stuff!\n* Authors of custom themes and extensions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgyaneesh%2Fstandardnotes-extensions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgyaneesh%2Fstandardnotes-extensions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgyaneesh%2Fstandardnotes-extensions/lists"}