1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-27 10:30:28 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/webserver
snlhnk c05c0d3df6 Module-ize server routes, add static file support and other enhancements(#2679)
* Module-ize server routes and add static file support (#2510)

* Refactor server routes to modules

New module type: serverroute

Caveats: Loading order is not deterministic but this would only matter
if two route modules attempted to use the same path regexp (that would
be silly).

* Add static assets plugin

This plugin allows the node server to fetch static assets in the /assets
directory. I felt that this was a feature that goes above the core
functionality. That is why I added it as a plugin. with the modular
route extensions this was a breeze.

* Add serverroute description to ModuleTypes

* Coding standards tweaks

* Fix filename typo

* Move support for attachments from a plugin into the core

* Missing "else"

* Refactor server handling

* Introduce a new named parameter scheme for commands
* Move the SimpleServer class into it's own module
* Deprecate the --server command because of the unwieldy syntax
* Add a new --listen command using the new syntax

For example:

tiddlywiki mywiki --listen host:0.0.0.0 port:8090

* Add check for unknown parameters

* Add support for multiple basic authentication credentials in a CSV file

Beware: Passwords are stored in plain text. If that's a problem, use an authenticating proxy and the trusted header authentication approach.

* Refactor module locations

* Rename "serverroute" module type to "route"

* Remove support for verifying optional named command parameters

The idea was to be able to flag unknown parameter names, but requiring a command to pre-specify all the parameter names makes it harder for (say) the listen command to be extensible so that plugins can add new optional parameters that they handle. (This is particularly in the context of work in progress to encapsulate authenticators into their own modules).

* Refactor the two authenticators into separate modules and add support for authorization

* Correct mistaken path.join vs. path.resolve

See https://stackoverflow.com/a/39836259

* Docs for the named command parameters

I'd be grateful if anyone with sufficient Windows experience could confirm that the note about double quotes in "NamedCommandParameters" is correct.

* Be consistent about lower case parameter names

* Do the right thing when we have a username but no password

With a username parameter but no password parameter we'll attribute edits to that username, but not require authentication.

* Remove obsolete code

* Add support for requiring authentication without restricting the username

* Refactor authorization checks

* Return read_only status in /status response

* Fix two code typos

* Add basic support for detecting readonly status and avoiding write errors

We now have syncadaptors returning  readonly status and avoid attempting to write to the server if it's going to fail

* Add readonly-styles

We hide editing-related buttons in read only mode

I've made this part of the tiddlyweb plugin but I think a case could be made for putting it into the core.

* Add custom request header as CSRF mitigation

By default we require the header X-Requested-With to be set to TiddlyWiki. Can be overriden by setting csrfdisable to "yes"

See https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet#Protecting_REST_Services:_Use_of_Custom_Request_Headers

* Add support for HTTPS

* First pass at a route for serving rendered tiddlers

cc @Drakor

* Tweaks to the single tiddler static view

Adding a simple sidebar

* Switch to "dash" separated parameter names

* Typo

* Docs: Update ServerCommand and ListenCommand

* First pass at docs for the new web server stuff

Writing the docs is turning out to be quite an undertaking, much harder than writing the code!

* Get rid of extraneous paragraphs in static renderings

* Rejig anonymous user handling

Now we can support wikis that are read-only for anonymous access, but allow a user to login for read/write access.

* More docs

Slowly getting there...

* Static tiddler rendering: Fix HTML content in page title

* Docs updates

* Fix server command parameter names

Missed off 30ce7ea

* Docs: Missing quotes

* Avoid inadvertent dependency on Node.js > v9.6.0

The listenOptions parameter of the plain HTTP version of CreateServer was only introduced in v9.6.0

cc @Drakor @pmario

* Typo
2018-07-18 16:54:43 +01:00
..
Using HTTPS.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
Using the integrated static file server.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
Using the read-only single tiddler view.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Anonymous Access.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Authentication.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Authorization.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Basic Authentication.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Guides.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Header Authentication.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ anon-username.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ authenticated-user-header.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ credentials.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ csrf-disable.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ debug-level.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ host.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ password.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ path-prefix.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ port.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ readers.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ root-render-type.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ root-serve-type.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ root-tiddler.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ tls-cert.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ tls-key.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ username.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameter_ writers.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Parameters.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer Routing.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00
WebServer.tid Module-ize server routes, add static file support and other enhancements(#2679) 2018-07-18 16:54:43 +01:00