From d062b13040d4a7870c52e5a8f8fd663cfb51403b Mon Sep 17 00:00:00 2001 From: dcvdiego Date: Tue, 19 Nov 2024 16:28:55 +0000 Subject: [PATCH 1/2] make docs slightly more readable --- docs/setup_own_server.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/setup_own_server.md b/docs/setup_own_server.md index 193f469..690f7ca 100644 --- a/docs/setup_own_server.md +++ b/docs/setup_own_server.md @@ -54,7 +54,7 @@ Please refer the [official document](https://docs.couchdb.org/en/stable/install/ ## 2. Run couchdb-init.sh for initialise ``` -$ curl -s https://raw.githubusercontent.com/vrtmrz/obsidian-livesync/main/utils/couchdb/couchdb-init.sh | bash +curl -s https://raw.githubusercontent.com/vrtmrz/obsidian-livesync/main/utils/couchdb/couchdb-init.sh | bash ``` If it results like following: @@ -83,7 +83,7 @@ Your CouchDB has been initialised successfully. If you want this manually, pleas Whatever solutions we can use. For the simplicity, following sample uses Cloudflare Zero Trust for testing. ``` -$ cloudflared tunnel --url http://localhost:5984 +cloudflared tunnel --url http://localhost:5984 2024-02-14T10:35:25Z INF Thank you for trying Cloudflare Tunnel. Doing so, without a Cloudflare account, is a quick way to experiment and try it out. However, be aware that these account-less Tunnels have no uptime guarantee. If you intend to use Tunnels in production you should use a pre-created named tunnel by following: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps 2024-02-14T10:35:25Z INF Requesting new quick Tunnel on trycloudflare.com... 2024-02-14T10:35:26Z INF +--------------------------------------------------------------------------------------------+ @@ -103,12 +103,17 @@ Now `https://tiles-photograph-routine-groundwater.trycloudflare.com` is our serv ### 1. Generate the setup URI on a desktop device or server ```bash -$ export hostname=https://tiles-photograph-routine-groundwater.trycloudflare.com #Point to your vault -$ export database=obsidiannotes #Please change as you like -$ export passphrase=dfsapkdjaskdjasdas #Please change as you like -$ export username=johndoe -$ export password=abc123 -$ deno run -A https://raw.githubusercontent.com/vrtmrz/obsidian-livesync/main/utils/flyio/generate_setupuri.ts +export hostname=https://tiles-photograph-routine-groundwater.trycloudflare.com #Point to your vault +export database=obsidiannotes #Please change as you like +export passphrase=dfsapkdjaskdjasdas #Please change as you like +export username=johndoe +export password=abc123 +deno run -A https://raw.githubusercontent.com/vrtmrz/obsidian-livesync/main/utils/flyio/generate_setupuri.ts +``` + +You will then get the following output: + +```bash obsidian://setuplivesync?settings=%5B%22tm2DpsOE74nJAryprZO2M93wF%2Fvg.......4b26ed33230729%22%5D Your passphrase of Setup-URI is: patient-haze From 08d7d24baf0bbc526ebf070b107bc49c72b1d120 Mon Sep 17 00:00:00 2001 From: dcvdiego Date: Sat, 21 Dec 2024 16:26:55 +0000 Subject: [PATCH 2/2] Update setup_own_server.md --- docs/setup_own_server.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/setup_own_server.md b/docs/setup_own_server.md index 690f7ca..27b415d 100644 --- a/docs/setup_own_server.md +++ b/docs/setup_own_server.md @@ -84,6 +84,11 @@ Whatever solutions we can use. For the simplicity, following sample uses Cloudfl ``` cloudflared tunnel --url http://localhost:5984 +``` + +You will then get the following output: + +``` 2024-02-14T10:35:25Z INF Thank you for trying Cloudflare Tunnel. Doing so, without a Cloudflare account, is a quick way to experiment and try it out. However, be aware that these account-less Tunnels have no uptime guarantee. If you intend to use Tunnels in production you should use a pre-created named tunnel by following: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps 2024-02-14T10:35:25Z INF Requesting new quick Tunnel on trycloudflare.com... 2024-02-14T10:35:26Z INF +--------------------------------------------------------------------------------------------+