quenousimporte
/
notes
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
quenousimporte 2023-10-26 10:30:29 +02:00
parent 1df82354e3
commit 1899ba35ca
1 changed files with 10 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
readme.md
View File

@ -6,26 +6,23 @@ Launch index.html from your web server or try https://notes.ouvaton.org.
Your notes are stored in your browser local storage. Your notes are stored in your browser local storage.
## Usage
* command palette: ctrl+shift+p
* notes list: ctrl+p
## Remote mode ## Remote mode
You can use remote mode with your own php server to access your notes from the cloud. You can use remote mode with your own php server to access your notes from the cloud:
* put the source files on your php server * put the source files on your php server
* browse index.html * browse index.html
* launch command "edit pgp keys" and paste your public and private keys as a single file (passphrase is not supported) * launch command "edit pgp keys" and paste your public and private keys as a single file (passphrase is not supported)
* switch to remote mode: ctrl+shift+V * switch to remote mode: ctrl+shift+V
Your data file will never reach the server unencrypted. Your data file will always be encrypted before reaching the server.
To protect your data file access by a password, edit settings.php and change `$password` variable. To protect your data file access by a password, edit settings.php and change `$password` variable. Your password will be sent from browser to server through a post http query, encrypted with ssl if enabled. It is stored unencrypted in your browser local storage and in the settings.php file on server side.
Your password will be sent from browser to server through a post http query with no more encryption than ssl, if enabled. Password is stored unencrypted in your browser local storage and in the settings.php file on server side.
## Usage
* help: f1
* notes list: ctrl+p
* command palette: ctrl+shift+p
## Cli tool ## Cli tool
@ -36,8 +33,6 @@ python3 app.py
Requires python3, curl, gnupg and a text editor. Requires python3, curl, gnupg and a text editor.
## Reclaim your data ## Export your data
Download your notes in a single json file with ctrl+shift+S. You can download your notes in a single json data file, or as flat markdown files in a zip archive.
Dowload a zip file of your notes as markdown files with command "Download all notes in a zip file"