TiddlyWiki5/editions/tw5.com/tiddlers/commands/ServerCommand.tid

title: ServerCommand
tags: command

The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage - in particular, TiddlyWiki5 is an old-school wiki in the sense that it offers no authentication.

At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.

```
--server <port> <roottiddler> <rendertype> <servetype> <username>
```

The parameters are:

* ''port'' - port number to serve from (defaults to "8080")
* ''roottiddler'' - the tiddler to serve at the root (defaults to "$:/core/tiddlywiki5.template.html") 
* ''rendertype'' - the content type to which the root tiddler should be rendered (defaults to "text/plain")
* ''servetype'' - the content type with which the root tiddler should be served (defaults to "text/html")
* ''username'' - the default username for signing edits
* ''password'' - optional password for basic authentication

If the password parameter is specified then the browser will prompt the user for the username and password. Note that the password is transmitted in plain text so this implementation isn't suitable for general use.

For example:

```
--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName
```
More docs updating 2012-06-10 16:48:23 +00:00			`title: ServerCommand`
Get rid of the 'docs' tag It was unnecessary, since everything here is documentation 2013-08-25 20:41:00 +00:00			`tags: command`
More docs updating 2012-06-10 16:48:23 +00:00
Docs updates 2013-03-12 19:01:14 +00:00			`The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage - in particular, TiddlyWiki5 is an old-school wiki in the sense that it offers no authentication.`

			At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.
More docs updating 2012-06-10 16:48:23 +00:00
Docs updates 2013-01-16 13:44:09 +00:00			```
Allow username to be set for the built-in server 2013-08-21 08:53:45 +00:00			`--server <port> <roottiddler> <rendertype> <servetype> <username>`
Docs updates 2013-01-16 13:44:09 +00:00			```
More docs updating 2012-06-10 16:48:23 +00:00
			`The parameters are:`

			`* ''port'' - port number to serve from (defaults to "8080")`
			`* ''roottiddler'' - the tiddler to serve at the root (defaults to "$:/core/tiddlywiki5.template.html")`
			`* ''rendertype'' - the content type to which the root tiddler should be rendered (defaults to "text/plain")`
			`* ''servetype'' - the content type with which the root tiddler should be served (defaults to "text/html")`
Allow username to be set for the built-in server 2013-08-21 08:53:45 +00:00			`* ''username'' - the default username for signing edits`
Added primitive support for basic authentication Note that the password will be passed over HTTP in plain text. 2013-11-28 14:03:08 +00:00			`* ''password'' - optional password for basic authentication`

			`If the password parameter is specified then the browser will prompt the user for the username and password. Note that the password is transmitted in plain text so this implementation isn't suitable for general use.`
Allow username to be set for the built-in server 2013-08-21 08:53:45 +00:00
			`For example:`

			```
			`--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName`
			```