syncthing / syncthing/docs

Improve discosrv documentation for debugging

Open
#918 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
327
Forks
653
PR merge metrics
No merged PRs in 30d

Description

I'm having a hard time debugging a Discovery Server install.

It's behind a Caddy proxy so I've implemented the required directives from the documentation and it seems to be working but there's not mush I can do to test the API.

I've pointed 3 clients at the base url (https://example.com/), but they are unable to discover each other.
If I curl the base address of my Caddy server, or directly to the backend (https://example.com:8443/) it just returns "Not Found" without any http response header.
The logs show nothing, even when calling the baseURL, but since there's no API docs I don't know what else to try.

I am running stdiscosrv-linux-arm64-v1.29.5 with the flags --http, --debug, and I also added the flag --db-dir=/data since the startup message showed Error reading database: open records.db: no such file or directory but this error still remains. Am I supposed to init a DB or something?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked stdiscosrv documentation and reproduce the reported requests against the base URL and backend using the stated --http, --debug, and --db-dir flags. Determine which API or health-check endpoints and database initialization behavior should be documented. Done means the documentation gives a newcomer concrete debugging requests and explains the records.db error.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.