How to Setup Docker-Container and generate Device Token (displayed on Ugreen-NAS (UGOS))

[Carlvonher]

How to setup your Docker Container and generate your Device-Token with individual Vaults.

Since you cannot create a terminal in the Docker Container to generate your Tokens, you have to go a workaround explained below:

[Carlvonher]

Docker Setup

1. Folder Setup 📁

First create your Folder including the "data" Folder

2. Docker Compose 🛠️

You can use the given Docker Compose, but for UGOS it is advised to use full-paths, so here is my Docker Compose:

 services:
  lockstep-sync:
    image: ghcr.io/stephansergeev/obsidian-lockstep-sync:latest
    container_name: lockstep-sync
    restart: unless-stopped
    ports:
      - "8051:8080" # I remapped the Port to 8051
    volumes:
      - /volume1/docker/obsidian-lockstep-sync/data:/data #Your Folder-Path

---

Genrate Token

To access the Docker Container, and the SQlite DB, you have to use ssh to connect with the Ugreen NAS

Connect to your DB 🛜

To connect to your DB you open cmd on your PC and follow these steps:

1. Enter ssh Username@IP-Adresse-of-your-NAS
   For example ssh Carlvonher@192.168.178.111

2. Enter your Password

(cmd may not show the PW or any clue of input, but it does!)
These are your Username and Password, that you normaly use to log into your NAS

3. sudo docker run --rm -v *path-to-your-db*:/data ghcr.io/stephansergeev/obsidian-lockstep-sync:latest token list
   For example: sudo docker run --rm -v /volume1/docker/obsidian-lockstep-sync/data:/data ghcr.io/stephansergeev/obsidian-lockstep-sync:latest token list

The path is set by you in your YAML (see above volumes: )
Sudo will ask for your password again, but only once per session (or maybe an Admin-PW, was the same for me)

Generate your Tokens (with Multivault in one DB) 🪪

4. If you successfully reached your empty list of token "no tokens", you can use following command to create your Device Token:
   sudo docker run --rm -v **path-to-your-db**:/data ghcr.io/stephansergeev/obsidian-lockstep-sync:latest token add --vault <Vault-name> --name <Device-name>

For Example:sudo docker run --rm -v /volume1/docker/obsidian-lockstep-sync/data:/data ghcr.io/stephansergeev/obsidian-lockstep-sync:latest token add --vault "privat" --name "Laptop"

5. Important: Copy each generated Token into a secure place, it is Only shown once!
   If you List your tokens again with Step 3, you can now see, that a token with the given name is registered in your DB

With this you can create and display all your Tokens, without the interface within Obsidian "add Device"

Connect your Obsidian Vault 🌐

6. Insert the generated Token in the Add-on within Obsidian and connect your Device to your DB
   and please close the ssh entrance to your NAS again.😁🔒

At this Point you can use the link command to generate a link for your Device to connect with the generated Token, but I used copy and paste and was happy. 🧐😁

---

If I missed something, please consider adding it below.

[Carlvonher]

If you get synchronization Errors, persisting through restarts of Obsidian and reactivating Lockstep Sync:
404 not found in Database ❌

Try deleting
Local-Path-to-Vault\.obsidian\plugins\lockstep-sync\index.json 📄
and
Local-Path-to-Vault\.obsidian\plugins\lockstep-sync\index.prev.json 📄

It will forget any deleted Files, that are not registered on your DB 😵‍💫 and synchronize your Vault to your DB again.

[stephansergeev]

This is excellent, thank you for writing it up. One correction to save people a headache: token add/token list without --vault act on the default vault named main. For a second vault, add --vault <name> to the add command (list always shows every vault, with a VAULT column). Mind if I link this from the README as the Docker/NAS token guide?

[Carlvonher]

Let me rewrite it into one complete guide including multi-Vault. After I manage to set it up and test the V1.0.7.

But sure, go ahead. And link it to the readme.

I made it for UGOS, but maybe it works in all Docker. I dont know that.

I would also add the hole setup in UGOS, just to make the path clear.

[Carlvonher]

Im done. If you got nothing to add or change, you can link it in the Readme as Docker Guide 😉