Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting Started is missing most of what you need to get started #139

Open
felzix opened this issue Sep 16, 2024 · 1 comment
Open

Getting Started is missing most of what you need to get started #139

felzix opened this issue Sep 16, 2024 · 1 comment

Comments

@felzix
Copy link

felzix commented Sep 16, 2024

I can't get tiddlyserver to work because there just isn't documentation in the obvious place (if anywhere?) that explains the total steps.

Missing information:

  • How to make an account. It isn't clear why there are accounts nor how to set them up. Digging into the documentation for the settings JSON, I figured out how to do this step, but that information should be in Getting Started because it appears to be 100% necessary for the "happy path".
  • There should be a complete settings JSON in the documentation. The current state of the default JSON is pretty good and the documentation is extensive but having a single fully-fleshed-out JSON is helpful. In particular, I ran into the issue where my authAccounts were missing the group and the config verifier didn't tell me that fact. Also I am unsure what groups are for... I realllllly just want a server for myself so I don't need to remember to click save or get interrupted every time I edit a page.
  • Unsure what the PUT thing is. Like obviously it's supposed to talk to the server but I read the code and still don't understand... I am skeptical it works as expected since it seems to be pulling from the document URL, which for tiddlywiki is a file path. Is there some other way to use tiddlywiki with tiddlyserver?

As it stands, it tells me it saved only when it's set up to ask me to save every time I edit a page. It doesn't seem to actually use tiddlyserver.

@Arlen22
Copy link
Owner

Arlen22 commented Sep 20, 2024

Are you referring to this page? https://arlen22.github.io/tiddlyserver/docs/gettingstarted

There is a JSON file on that page which should have everything you need. Auth accounts is an advanced feature that I've personally used but the entire thing is so hacky I myself forget half the time how I did it if I don't use it for long enough. That part definitely needs work.

The PUT saver is for single file wikis. You might have to save manually, but you should never be given a file to download. I forget exactly how that works.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants