Share Note backend server
June 3, 2026 ยท View on GitHub
Backend server for Share Note.
Change your Obsidian plugin to point to your server
Change the server URL in your <VAULT_DIR>/.obsidian/plugins/share-note/data.json file. Either reload the plugin or reload Obsidian for the changes to take effect.
This file will sync to all your devices using your normal sync method, so all your devices will update.
Run with Docker
- Take a copy of the docker-compose.yml file
- Take a copy of the example env file and save as
.env - Update the
.envoptions as below docker-compose up -d
.env options
| Option | Example | Description |
|---|---|---|
| BASE_WEB_URL | https://example.com | The base public URL for your server. |
| HASH_SALT | Any random string | |
| MAXIMUM_UPLOAD_SIZE_MB | 5 | The maximum allowed size for user uploads in megabytes (MB). |
| FOLDER_PREFIX | 0 | OPTIONAL. Set this to 1 or 2 if you want user files to be split into subfolders based on the first N characters of the filename. |
| ALLOW_NEW_USERS | true | OPTIONAL. Set this to false to disable new user registration. Existing users can still generate new API keys. |
| FILENAME_LENGTH_HTML | 8 | OPTIONAL. Length of the random base36 filename for shared notes. Default 8. Lower values shorten URLs but raise collision risk. |
| CLOUDFLARE_TURNSTILE_KEY | OPTIONAL. If you want to use Turnstile to show a captcha when someone creates an account. | |
| CLOUDFLARE_TURNSTILE_SECRET | OPTIONAL. If you want to use Turnstile to show a captcha when someone creates an account. | |
| CLOUDFLARE_ZONE_ID | OPTIONAL. If you want to use Cloudflare proxy in front of your server. | |
| CLOUDFLARE_API_KEY | OPTIONAL. If you want to use Cloudflare proxy in front of your server. |