mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-07-05 19:53:17 +00:00
c05c0d3df6
* 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
69 lines
3.5 KiB
Plaintext
69 lines
3.5 KiB
Plaintext
caption: Internet Information Services
|
|
created: 20180328120356008
|
|
delivery: DIY
|
|
description: Windows' built-in web server
|
|
method: sync
|
|
modified: 20180701185718671
|
|
tags: Saving [[TiddlyWiki on Node.js]] Windows
|
|
title: Installing TiddlyWiki on Microsoft Internet Information Server
|
|
type: text/vnd.tiddlywiki
|
|
|
|
\define example-file(title)
|
|
<$transclude tiddler="$title$" mode="block"/> <$macrocall $name="copy-to-clipboard" src={{$title$}}/>
|
|
\end
|
|
|
|
Microsoft's [[Internet Information Server|https://en.wikipedia.org/wiki/Internet_Information_Services]] (IIS) is the built-in web server for Windows. It can be useful to host TiddlyWiki within IIS in order to take advantage of IIS features like URL rewriting, static file hosting and automatic restarts after a crash.
|
|
|
|
! 1. Enable IIS
|
|
|
|
# In Windows, access the Control Panel and click ''Add or Remove Programs''
|
|
# In the Add or Remove Programs window, click ''Add/Remove Windows Components''.
|
|
# Select the ''Internet Information Services (IIS)'' check box
|
|
# Click ''Next'', then click ''Finish''
|
|
|
|
! 2. Install the required tools
|
|
|
|
# Install the IIS module ~HttpPlatformHandler from https://www.iis.net/downloads/microsoft/httpplatformhandler
|
|
# Install [[Node.js]] from https://nodejs.org/
|
|
# Install Git from https://git-scm.com/
|
|
#* //optional; only required when using the latest TiddlyWiki release pulled directly from ~GitHub -- see below//
|
|
|
|
! 3. Install TiddlyWiki and setup a new wiki
|
|
|
|
# Create a convenient directory for the wiki (e.g. `C:\MyStuff`)
|
|
# Within it, create a file called `C:\MyStuff\package.json` with the content:
|
|
#> <<example-file "Example package.json for IIS">>
|
|
# Also create a file called `C:\MyStuff\web.config` with the content:
|
|
#> <<example-file "Example web.config for IIS">>
|
|
# Create a subdirectory called "wiki" (i.e. `C:\MyStuff\wiki`)
|
|
# Create a file called `C:\MyStuff\wiki\tiddlywiki.info` with the content:
|
|
#> <<example-file "Example tiddlywiki.info for IIS">>
|
|
# Create a subdirectory called "tiddlers" (i.e. `C:\MyStuff\wiki\tiddlers`)
|
|
# Within it, create a file called `C:\MyStuff\wiki\tiddlers\config-tiddlyweb-host.tid` with the content:
|
|
#> <<example-file "Example config-tiddlyweb-host for IIS">>
|
|
#* (See [[the documentation|https://docs.microsoft.com/en-us/iis/extensions/httpplatformhandler/httpplatformhandler-configuration-reference]] for details of the configuration fields for ~HttpPlatformHandler
|
|
# Execute the command `npm install` within the `C:/MyStuff` directory
|
|
|
|
! 4. Setup the application in IIS
|
|
|
|
* In Windows, run the IIS Manager application (use the start menu to run `inetmgr.exe`)
|
|
* Locate the server in the ''Connections'' column on the left, and click the disclosure triangle to show its content
|
|
* Open the ''Sites'' folder
|
|
* Right click on the ''Default Web Site'' entry, and select ''Add application..'' from the menu
|
|
* Enter the following information in the dialogue box:
|
|
*# ''Alias'': `MyApp`
|
|
*# ''Physical path'': `C:\MyStuff`
|
|
* Click ''OK''
|
|
|
|
! 5. Test the application
|
|
|
|
Test the app by visiting http://localhost/MyApp/ in a browser.
|
|
|
|
! Notes
|
|
|
|
* If you require authentication, specify a username and password in the `--listen` command in `web.config`. For example:
|
|
** `arguments=".\node_modules\tiddlywiki\tiddlywiki.js ./wiki-server --listen username=joe "password=bloggs" port=PORT path-prefix=/MyApp">`
|
|
** Take note of the need to use double quotes around non-alphanumeric passwords, and to HTML encode them into `"`
|
|
* If you change the settings in the `web.config` file, or modify the app code, then you'll need to restart the server using the IIS manager application
|
|
|