diff --git a/Cloning.md b/Cloning notes.md similarity index 100% rename from Cloning.md rename to Cloning notes.md diff --git a/Installation as webapp.md b/Installation as webapp.md new file mode 100644 index 0000000..564489c --- /dev/null +++ b/Installation as webapp.md @@ -0,0 +1,30 @@ +This pages describes installing Trilium as a web application as opposed to installing desktop (electron) build. + +Trilium as web application is typically used as a [[sync|Synchronization]] server, but can be also used as online version of Trilium. + +## Requirements + +Trilium is a [node.js](http://nodejs.org/) application. Supported version is 8.2.1 and up, but it might work with earlier versions, it's just not tested. It will definitely not run on node version lower than 7.6 though (first version with async/await enabled). + +## Installation + +### Download +You can either download source code zip/tar from [[latest release|https://github.com/zadam/trilium/releases/latest]] or clone git repository from stable branch with ```git clone -b stable https://github.com/zadam/trilium.git``` + +## Installation +~~~ +cd trilium + +# download all node dependencies +npm install +~~~~ + +## Run + +~~~~ +cd trilium + +# using nohup to make sure trilium keeps running after user logs out +nohup node bin/www & +~~~~ + diff --git a/Installation on server.md b/Installation on server.md deleted file mode 100644 index c09d725..0000000 --- a/Installation on server.md +++ /dev/null @@ -1,27 +0,0 @@ -By server installation we mean installing Trilium as a web application as opposed to installing desktop (electron) build. - -## Requirements - -Trilium is a [node.js](http://nodejs.org/) application. Supported version is 8.2.1 and up, but it might work with earlier versions, it's just not tested. It will definitely not run on node version lower than 7.6 though (first version with async/await enabled). - -## Install from git -~~~ -git clone https://github.com/zadam/trilium.git -cd trilium - -# stable branch should contain latest stable release -git checkout stable - -# download all node dependencies -npm install -~~~~ - -## Run - -~~~~ -cd trilium - -# using nohup to make sure trilium keeps running after user logs out -nohup node bin/www & -~~~~ - diff --git a/Links.md b/Links.md index 040a639..8d1c095 100644 --- a/Links.md +++ b/Links.md @@ -11,7 +11,7 @@ You can follow external link by either double clicking (will open new tab/window Links to internal notes are created a bit differently. To create link to note at current cursor position, press ```CTRL-L```. -In the dialog you can see radio button to choose from different types of linking. First one is classic link to note, the other two are related to [[cloning|Cloning]] and will be covered separately. +In the dialog you can see radio button to choose from different types of linking. First one is classic link to note, the other two are related to [[cloning|Cloning notes]] and will be covered separately. [[gifs/create-link-to-note.gif]] diff --git a/Protected notes.md b/Protected notes.md index 518ddb7..264b5f6 100644 --- a/Protected notes.md +++ b/Protected notes.md @@ -10,6 +10,14 @@ For such sensitive data Trilium can protect these notes which essentially means: **Be aware that currently protected notes is considered to be experimental. It's possible encryption method will change in the future (migration path will be provided).** +## How to use protected notes + +Notes are by default unprotected. If you want your note to be protected, click on lock icon next to the note title as seen here: + +[[gifs/protecting-note.gif]] + +You can also notice how protected notes are greyed in both note tree and note editor so you have good overview of what's protected and what isn't. + ## What is encrypted In principle Trilium encrypts data, but doesn't encrypt metadata. This specifically means: diff --git a/gifs/protecting-note.gif b/gifs/protecting-note.gif new file mode 100644 index 0000000..95a7441 Binary files /dev/null and b/gifs/protecting-note.gif differ