Standard Notes Extensions - Self-Hosted Repository
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
iganeshk 7184f2aa8e
cleanup
3 months ago
extensions added mfa 3 months ago
.gitignore Implement Github API 6 months ago
LICENSE rev. 1 6 months ago
README.md Updated README to fix issue with build command 5 months ago
build_repo.py fix: typography 6 months ago
env.sample Implement Github API 6 months ago
requirements.txt Implement Github API 6 months ago

README.md

Standard Notes Extension Repository

Standard Notes Extensions - Self-Hosted Repository

Host Standard Notes extensions on your own server. This utility parses most of the open-source extensions available from original repository as well as from other authors and builds an extensions repository which then can be plugged directly into Standard Notes Web/Desktop Clients. (https://standardnotes.org/)

Extensions are listed as YAML in the \extensions sub-directory, pull a request if you’d like to add yours.

Requirements

  • Python 3
    • pyyaml module
    • requests module

Demo

Standard Notes Extension Repository Demo

Usage

  • Clone this repository to the web-server:
$ git clone https://github.com/iganeshk/standardnotes-extensions.git
$ cd standardnotes-extensions
$ pip3 install -r requirements.txt
  • Use the env.sample to create a .env file for your environment variables. The utility will automatically load these when it starts.
# Sample ENV setup Variables (YAML)
# Copy this file and update as needed.
#
#   $ cp env.sample .env
#
# Do not include this new file in source control
# Github Credentials
# Generate your token here: https://github.com/settings/tokens
# No additional permission required, this is just to avoid github api rate limits
#

domain: https://your-domain.com/extensions

github:
  username: USERNAME
  token: TOKEN

  • [Optional] Make additions or appropriate changes in /extensions directory.
  • Run the utility:
$ python3 build_repo.py
  • Serve the /public directory and verify if the endpoint is reachable.
https://your-domain.com/extensions/index.json
  • Import the above endpoint into the web/desktop client. (Note: Enable CORS for your web server respectively, nginx setup provided below)

Setup with nginx

	location ^~ /extensions {
		autoindex off;
		alias /path/to/standardnotes-extensions/public;
		# CORS HEADERS
		if ($request_method = 'OPTIONS') {
		   add_header 'Access-Control-Allow-Origin' '*';
		   add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
		   #
		   # Custom headers and headers various browsers *should* be OK with but aren't
		   #
		   add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
		   #
		   # Tell client that this pre-flight info is valid for 20 days
		   #
		   add_header 'Access-Control-Max-Age' 1728000;
		   add_header 'Content-Type' 'text/plain; charset=utf-8';
		   add_header 'Content-Length' 0;
		   return 204;
		}
		if ($request_method = 'POST') {
		   add_header 'Access-Control-Allow-Origin' '*';
		   add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
		   add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
		   add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range';
		}
		if ($request_method = 'GET') {
		   add_header 'Access-Control-Allow-Origin' '*';
		   add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
		   add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
		   add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range';
		}
	}

Acknowledgments