TiddlyWiki5/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid

created: 20131219100637788
modified: 20141015165343893
tags: [[TiddlyWiki on Node.js]]
title: Scripts for TiddlyWiki on Node.js
type: text/vnd.tiddlywiki

! Script Files

The TiddlyWiki5 repository contains several scripts in the `bin` folder that you can use to automate common tasks, or as a useful starting point for your own scripts. See [[Scripts for building tiddlywiki.com]] for details of the scripts used to build and release http://tiddlywiki.com/.

All the scripts expect to be run from the root folder of the repository.

!! `serve`: serves tw5.com

```
./bin/serve.sh -h
./bin/serve.sh [edition dir] [username] [password] [host] [port]
```

Or:

```
./bin/serve.cmd -h
./bin/serve.cmd [edition dir] [username] [password] [host] [port]
```

This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the `tw5.com-server` edition. By default, the Node.js serves on port 8080. If the optional `username` parameter is provided, it is used for signing edits. If the `password` is provided then HTTP basic authentication is used. Run the script with the `-h` parameter to see online help.

To experiment with this configuration, run the script and then visit `http://127.0.0.1:8080` in a browser.

Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).

!! `test`: build and run tests

This script runs the `test` edition of TiddlyWiki on the server to perform the server-side tests and to build `test.html` for running the tests in the browser.

!! `lazy`: serves tw5.com with lazily loaded images

```
./bin/lazy.sh <username> [<password>]
```

Or:

```
./bin/lazy.cmd <username> [<password>]
```

This script serves the `tw5.com-server` edition content with LazyLoading applied to images.

!! `2bld`: builds TiddlyWiki 2.6.5

This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (`diff` is used for *nix, `fc` for Windows).
Docs updates 2013-12-19 10:08:14 +00:00			`created: 20131219100637788`
Docs updates 2014-10-15 20:56:32 +00:00			`modified: 20141015165343893`
Lots more docs updates 2014-09-12 15:05:37 +00:00			`tags: [[TiddlyWiki on Node.js]]`
Docs updates 2013-12-19 10:08:14 +00:00			`title: Scripts for TiddlyWiki on Node.js`
			`type: text/vnd.tiddlywiki`

			`! Script Files`

Docs updates 2014-10-15 20:56:32 +00:00			The TiddlyWiki5 repository contains several scripts in the `bin` folder that you can use to automate common tasks, or as a useful starting point for your own scripts. See [[Scripts for building tiddlywiki.com]] for details of the scripts used to build and release http://tiddlywiki.com/.
Move scripts into bin directory Fixes #807 2014-09-08 15:32:32 +00:00
			`All the scripts expect to be run from the root folder of the repository.`
Docs updates 2013-12-19 10:08:14 +00:00
			!! `serve`: serves tw5.com

			```
Docs updates for new file locations 2014-09-17 19:01:00 +00:00			`./bin/serve.sh -h`
			`./bin/serve.sh [edition dir] [username] [password] [host] [port]`
Docs updates 2013-12-19 10:08:14 +00:00			```

			`Or:`

			```
Docs updates for new file locations 2014-09-17 19:01:00 +00:00			`./bin/serve.cmd -h`
			`./bin/serve.cmd [edition dir] [username] [password] [host] [port]`
Docs updates 2013-12-19 10:08:14 +00:00			```

Docs updates 2014-09-19 14:02:40 +00:00			This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the `tw5.com-server` edition. By default, the Node.js serves on port 8080. If the optional `username` parameter is provided, it is used for signing edits. If the `password` is provided then HTTP basic authentication is used. Run the script with the `-h` parameter to see online help.
Docs updates 2013-12-19 10:08:14 +00:00
Switch to using 127.0.0.1 in docs 2014-01-02 20:07:05 +00:00			To experiment with this configuration, run the script and then visit `http://127.0.0.1:8080` in a browser.
Docs updates 2013-12-19 10:08:14 +00:00
			`Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).`

Move scripts into bin directory Fixes #807 2014-09-08 15:32:32 +00:00			!! `test`: build and run tests

			This script runs the `test` edition of TiddlyWiki on the server to perform the server-side tests and to build `test.html` for running the tests in the browser.

Docs updates 2014-02-06 22:21:03 +00:00			!! `lazy`: serves tw5.com with lazily loaded images
Docs updates 2013-12-19 10:08:14 +00:00
Docs updates 2014-02-06 22:21:03 +00:00			```
Move scripts into bin directory Fixes #807 2014-09-08 15:32:32 +00:00			`./bin/lazy.sh <username> [<password>]`
Docs updates 2014-02-06 22:21:03 +00:00			```

			`Or:`

			```
Move scripts into bin directory Fixes #807 2014-09-08 15:32:32 +00:00			`./bin/lazy.cmd <username> [<password>]`
Docs updates 2014-02-06 22:21:03 +00:00			```

Move scripts into bin directory Fixes #807 2014-09-08 15:32:32 +00:00			This script serves the `tw5.com-server` edition content with LazyLoading applied to images.
Docs updates 2014-02-06 22:21:03 +00:00
Docs updates 2013-12-19 10:08:14 +00:00			!! `2bld`: builds TiddlyWiki 2.6.5

Move scripts into bin directory Fixes #807 2014-09-08 15:32:32 +00:00			This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (`diff` is used for *nix, `fc` for Windows).