2023-01-18 12:34:55 +01:00
# notes
2023-09-21 22:04:20 +02:00
## Getting started
2023-01-18 12:34:55 +01:00
2023-09-21 22:04:20 +02:00
Launch index.html from your web server or try https://notes.ouvaton.org.
2023-01-18 12:34:55 +01:00
2023-09-21 22:04:20 +02:00
Your notes are stored in your browser local storage.
2023-01-18 12:34:55 +01:00
2023-10-26 10:30:29 +02:00
## Usage
* command palette: ctrl+shift+p
* notes list: ctrl+p
2023-10-27 16:59:14 +02:00
## Sync feature
2023-01-18 12:34:55 +01:00
2023-10-27 16:59:14 +02:00
To sync your notes in the cloud:
2023-01-18 12:34:55 +01:00
2023-01-23 12:50:52 +01:00
* put the source files on your php server
2023-07-17 09:42:02 +02:00
* browse index.html
2023-10-27 16:59:14 +02:00
* paste your public and private PGP keys as a single file (passphrase is not supported)
* refresh the page
2023-01-18 12:34:55 +01:00
2023-10-27 16:59:14 +02:00
Your data is always encrypted before reaching the server.
2023-07-17 09:42:02 +02:00
2023-10-27 16:59:14 +02:00
To protect your data file access by a password, edit settings.php and change `$password` variable. The password is 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.
2023-01-18 12:34:55 +01:00
2023-09-21 22:04:20 +02:00
## Cli tool
2023-09-18 09:14:41 +02:00
```
cd cli
python3 app.py
```
2023-09-21 22:06:13 +02:00
Requires python3, curl, gnupg and a text editor.
2023-09-21 22:04:20 +02:00
2023-10-26 10:30:29 +02:00
## Export your data
2023-01-18 12:34:55 +01:00
2023-10-26 10:30:29 +02:00
You can download your notes in a single json data file, or as flat markdown files in a zip archive.
