mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-05 01:26:18 +00:00
Code Issues Releases Wiki Activity
e114fed3f9
TiddlyWiki5/editions/tw5.com/tiddlers/nodejs/Installing TiddlyWiki on Node.js.tid

40 lines
2.0 KiB
Plaintext
Raw Normal View History

Updated GettingStarted material about saving changes
2017-11-13 14:00:01 +00:00
caption: Node.js
Docs updates
2013-12-19 10:08:14 +00:00
created: 20131219100608529
Updated GettingStarted material about saving changes
2017-11-13 14:00:01 +00:00
delivery: DIY
description: Flexible hosting on your own machine or in the cloud
method: sync
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 15:54:43 +00:00
modified: 20180701185303780
Updated GettingStarted material about saving changes
2017-11-13 14:00:01 +00:00
tags: Saving [[TiddlyWiki on Node.js]] Windows Mac Linux
Docs updates
2013-12-19 10:08:14 +00:00
title: Installing TiddlyWiki on Node.js
type: text/vnd.tiddlywiki
A third way to use TW5 on Android (#2415)
2016-04-30 20:47:09 +00:00
# Install [[Node.js]]
Docs update: add link to Termux for Android docs
2017-11-15 17:41:47 +00:00
#* 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
A third way to use TW5 on Android (#2415)
2016-04-30 20:47:09 +00:00
#* or directly from http://nodejs.org
Docs updates
2013-12-19 10:08:14 +00:00
# Open a command line terminal and type:
Docs update
2013-12-31 11:36:51 +00:00
#> `npm install -g tiddlywiki`
Docs updates
2013-12-19 16:45:13 +00:00
#> If it fails with an error you may need to re-run the command as an administrator:
Clarify references to sudo
2014-01-02 21:47:01 +00:00
#> `sudo npm install -g tiddlywiki` (Mac/Linux)
Docs updates
2013-12-19 10:08:14 +00:00
# Check TiddlyWiki is installed by typing:
#> `tiddlywiki --version`
Docs tweaks
2015-03-25 22:15:51 +00:00
# In response, you should see TiddlyWiki report its current version (eg "<<version>>"; you may also see other debugging information reported)
Docs updates
2013-12-19 10:08:14 +00:00
# Try it out:
Docs updates
2014-02-24 14:09:29 +00:00
## `tiddlywiki mynewwiki --init server` to create a folder for a new wiki that includes server-related components
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 15:54:43 +00:00
## `tiddlywiki mynewwiki --listen` to start TiddlyWiki
Switch to using 127.0.0.1 in docs
2014-01-02 20:07:05 +00:00
## Visit http://127.0.0.1:8080/ in your browser
Docs updates
2013-12-19 10:08:14 +00:00
## Try editing and creating tiddlers
Add build targets to server edition Define for the server edition the same build targets as for the empty edition, but using the correct template so that the "offline" version (target "index") works correctly when accessed via HTTP. With this, `tiddlywiki --build index` is equivalent to the save button. While the process of setting up TiddlyWiki on Node.js is well documented and easy enough, the options for publishing such a wiki to an offline version (scriptably, e.g. for push-to-deploy setups) are decidedly non-obvious. With the added build steps, the user only needs to know three simple commands: tiddlywiki --init server tiddlywiki --server tiddlywiki --build index and optionally tiddlywiki --build static
2016-04-03 19:22:11 +00:00
# Optionally, make an offline copy:
Fix sizes of SVG icons in documentation Fixes #4153
2019-10-13 14:35:36 +00:00
#* click the <<.icon $:/core/images/save-button>> ''save changes'' button in the sidebar, ''OR''
Add missing wiki directory to command example (#2950) All the other commands seem to assume that the user is not in the wiki directory, but rather in the parent directory: `tiddlywiki mynewwiki --init server` and `tiddlywiki mynewwiki --server`. This is why `tiddlywiki --build index` fails. A solution to this problem is to add the wiki name to the command.
2017-09-16 14:04:27 +00:00
#* `tiddlywiki mynewwiki --build index`
Add build targets to server edition Define for the server edition the same build targets as for the empty edition, but using the correct template so that the "offline" version (target "index") works correctly when accessed via HTTP. With this, `tiddlywiki --build index` is equivalent to the save button. While the process of setting up TiddlyWiki on Node.js is well documented and easy enough, the options for publishing such a wiki to an offline version (scriptably, e.g. for push-to-deploy setups) are decidedly non-obvious. With the added build steps, the user only needs to know three simple commands: tiddlywiki --init server tiddlywiki --server tiddlywiki --build index and optionally tiddlywiki --build static
2016-04-03 19:22:11 +00:00
Docs updates
2013-12-19 10:08:14 +00:00
The `-g` flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
Added text notifying users of issue #1434
2015-04-28 02:31:18 +00:00
Improvements to Android and fr-FR docs (#2418) * A third way to use TW5 on Android small improvements to Android/Node.js doc tiddlers * fr-FR translation for the link button * replace _ with space in file name
2016-05-02 10:08:27 +00:00
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]]
Added text notifying users of issue #1434
2015-04-28 02:31:18 +00:00
Add build targets to server edition Define for the server edition the same build targets as for the empty edition, but using the correct template so that the "offline" version (target "index") works correctly when accessed via HTTP. With this, `tiddlywiki --build index` is equivalent to the save button. While the process of setting up TiddlyWiki on Node.js is well documented and easy enough, the options for publishing such a wiki to an offline version (scriptably, e.g. for push-to-deploy setups) are decidedly non-obvious. With the added build steps, the user only needs to know three simple commands: tiddlywiki --init server tiddlywiki --server tiddlywiki --build index and optionally tiddlywiki --build static
2016-04-03 19:22:11 +00:00
Example Debian v8.0: `sudo ln -s /usr/bin/nodejs /usr/bin/node`
Doc: Adding comment to release notes re archived releases (#2882) * Doc: Adding comment to release notes to indicate where archived releases can be found. * Adding note about node.js to Release tiddler and Installing on Node.js tiddler
2017-06-09 14:33:24 +00:00
You can also install prior versions like this:
> npm install -g tiddlywiki@5.1.13
Reference in New Issue Copy Permalink