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

created: 20131219100608529
modified: 20160430162310620
tags: [[TiddlyWiki on Node.js]]
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, 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 --server` 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 --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 reciving 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`
Docs updates 2013-12-19 10:08:14 +00:00			`created: 20131219100608529`
A third way to use TW5 on Android (#2415) 2016-04-30 20:47:09 +00:00			`modified: 20160430162310620`
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: 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]]`
			#* either from your favourite package manager: typically `apt-get install nodejs` on Debian/Ubuntu Linux or Termux for Android, or `brew install node` on a Mac
			`#* 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
			## `tiddlywiki mynewwiki --server` 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:`
			`#* click the {{$:/core/images/save-button}} ''Save changes'' button in the sidebar, ''OR''`
			#* `tiddlywiki --build index`

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
Changed structure to use less space. 2015-04-28 02:40:20 +00:00			If you are using Debian or Debian-based Linux and you are reciving 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`