mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-08-30 13:02:53 +00:00
![snlhnk](/assets/img/avatar_default.png)
* 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
40 lines
2.0 KiB
Plaintext
40 lines
2.0 KiB
Plaintext
caption: Node.js
|
|
created: 20131219100608529
|
|
delivery: DIY
|
|
description: Flexible hosting on your own machine or in the cloud
|
|
method: sync
|
|
modified: 20180701185303780
|
|
tags: Saving [[TiddlyWiki on Node.js]] Windows Mac Linux
|
|
title: Installing TiddlyWiki on Node.js
|
|
type: text/vnd.tiddlywiki
|
|
|
|
# Install [[Node.js]]
|
|
#* either from your favourite package manager: typically `apt-get install nodejs` on Debian/Ubuntu Linux or [[Termux for Android|Serving TW5 from Android]], or `brew install node` on a Mac
|
|
#* or directly from http://nodejs.org
|
|
# Open a command line terminal and type:
|
|
#> `npm install -g tiddlywiki`
|
|
#> If it fails with an error you may need to re-run the command as an administrator:
|
|
#> `sudo npm install -g tiddlywiki` (Mac/Linux)
|
|
# Check TiddlyWiki is installed by typing:
|
|
#> `tiddlywiki --version`
|
|
# In response, you should see TiddlyWiki report its current version (eg "<<version>>"; you may also see other debugging information reported)
|
|
# Try it out:
|
|
## `tiddlywiki mynewwiki --init server` to create a folder for a new wiki that includes server-related components
|
|
## `tiddlywiki mynewwiki --listen` to start TiddlyWiki
|
|
## Visit http://127.0.0.1:8080/ in your browser
|
|
## Try editing and creating tiddlers
|
|
# Optionally, make an offline copy:
|
|
#* click the {{$:/core/images/save-button}} ''save changes'' button in the sidebar, ''OR''
|
|
#* `tiddlywiki mynewwiki --build index`
|
|
|
|
The `-g` flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
|
|
|
|
If you are using Debian or Debian-based Linux and you are receiving a `node: command not found` error though node.js package is installed, you may need to create a symbolic link between `nodejs` and `node`. Consult your distro's manual and `whereis` to correctly create a link. See github [[issue 1434|http://github.com/Jermolene/TiddlyWiki5/issues/1434]]
|
|
|
|
Example Debian v8.0: `sudo ln -s /usr/bin/nodejs /usr/bin/node`
|
|
|
|
You can also install prior versions like this:
|
|
|
|
> npm install -g tiddlywiki@5.1.13
|
|
|