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.

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

Categories

Details

Repository
ghcr.io/note-sx/server:latest
Last Updated2026-05-31
First Seen2025-10-20

Run Obsidian-ShareNote-Server on Unraid.

Obsidian-ShareNote-Server is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.