Obsidian-ShareNote-Server

Obsidian-ShareNote-Server

Docker app from Mackid1993's Repository

Overview

Instantly share a note, with the full theme and content exactly like you see it in Obsidian. Data is shared encrypted by default, and only you and the person you send it to have the key. More info: https://share.note.sx and https://github.com/alangrainger/share-note This is the selfhosted backend for the Obsidian Plugin. I did not create this, I am only creating a template for Unraid users. This is well paired with a Cloudflare tunnel. One could also set up Cloudflare Access: https://developers.cloudflare.com/cloudflare-for-platforms/cloudflare-for-saas/security/secure-with-access/ to "https://your-share-domain.com/v1/account" to prevent someone unauthorized from creating an account.

Readme

View on GitHub

Share Note backend server

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

  1. Take a copy of the docker-compose.yml file
  2. Take a copy of the example env file and save as .env
  3. Update the .env options as below
  4. 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.

Install Obsidian-ShareNote-Server on Unraid in a few clicks.

Find Obsidian-ShareNote-Server in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Obsidian-ShareNote-Server Review the template variables and paths Click Install
Explore Unraid OS

Categories

Productivity

Related apps

Explore more like this

Explore all
Productivity

Links

Projectgithub.comSupportforum.obsidian.mdGHCRghcr.ioTemplateraw.githubusercontent.com

Details

Repository
ghcr.io/note-sx/server:latest
Registry
https://ghcr.io/note-sx/server
Last Updated2026-07-17
First Seen2025-10-20

Runtime arguments

Network
bridge
Shell
sh
Privileged
false
Extra Params
--restart unless-stopped

Template configuration

BASE_WEB_URLVariable

The base public URL for your server.

NODE_ENVVariable
Default
production
Value
production
HASH_SALTVariable

REQUIRED: Any random string.

MAXIMUM_UPLOAD_SIZE_MBVariable

The maximum allowed size for user uploads in megabytes (MB).

CLOUDFLARE_TURNSTILE_KEYVariable

OPTIONAL. If you want to use Turnstile to show a captcha when someone creates an account.

CLOUDFLARE_TURNSTILE_SECRETVariable

OPTIONAL. If you want to use Turnstile to show a captcha when someone creates an account.

CLOUDFLARE_ZONE_IDVariable

OPTIONAL. If you want to use Cloudflare proxy in front of your server.

CLOUDFLARE_API_KEYVariable

OPTIONAL. If you want to use Cloudflare proxy in front of your server.

FOLDER_PREFIXVariable

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.

PUIDVariable
Default
99
Value
99
PGIDVariable
Default
100
Value
100
/notesx/dbPathrw

Database

Default
/mnt/user/appdata/notesx/db
Value
/mnt/user/appdata/notesx/db
/notesx/userfilesPathrw

User Files

Default
/mnt/user/appdata/notesx/userfiles
Value
/mnt/user/appdata/notesx/userfiles
PortPorttcp
Target
3000
Default
3000
Value
3000