Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Athlon1600/notepad
:page_facing_up: A very clever application for storing notes securely. Built with Vue + Node.js + Express
https://github.com/Athlon1600/notepad
aes correct-horse-battery-staple encryption notepad online-notepad pastebin scrypt textpad
Last synced: about 2 months ago
JSON representation
:page_facing_up: A very clever application for storing notes securely. Built with Vue + Node.js + Express
- Host: GitHub
- URL: https://github.com/Athlon1600/notepad
- Owner: Athlon1600
- License: mit
- Created: 2021-07-08T01:10:02.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T02:54:06.000Z (8 months ago)
- Last Synced: 2024-04-14T10:57:34.861Z (8 months ago)
- Topics: aes, correct-horse-battery-staple, encryption, notepad, online-notepad, pastebin, scrypt, textpad
- Language: JavaScript
- Homepage: https://notepad.mx/
- Size: 685 KB
- Stars: 10
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notepad
A simple web-based notepad for writing and securely storing notes online.
Useful for easy sharing of text between people or devices.
- No registration process. You use a passphrase as your login.
- Fully encrypted at client-side. No one can read your notes, except you.
- Extremely minimal and lightweight
## :star: Demo
Exact version of this application:
- https://notepad.mx
## :whale2: Deploy using Docker
Rent a server for free at [linode.com](https://www.linode.com/lp/refer/?r=cee8aa429cd4cbb5a6e6d1ebfd8986f661d8ef4e)
Install Docker 19+ on your new server:
```shell
curl -sSL https://get.docker.com/ | sh
```
and then run:
```shell
git clone https://github.com/Athlon1600/notepad.git
cd notepad
docker compose up -d
```
:heavy_check_mark: Application will be running on port 3000
Alternatively, you may run:
```shell
docker run -d -p 3000:3000 athlon1600/notepad
```
See our Docker Hub page here:
https://hub.docker.com/r/athlon1600/notepad
## :hammer: Deployment to Production (manual)
Rent a server for free at [linode.com](https://www.linode.com/lp/refer/?r=cee8aa429cd4cbb5a6e6d1ebfd8986f661d8ef4e)
Deploy this whole thing to production in three lines:
```shell
git clone https://github.com/Athlon1600/notepad.git
cd notepad
npm run build && npm run start
```
This will build Vue frontend first, and then move the resulting bundle to the `/public` directory
of the backend application from which the frontend will be served from.
:heavy_check_mark: Application will then be available on port 3000
## :globe_with_meridians: Caddy Server
If you want HTTPS support out of the box, you should install Caddy:
```shell
wget -qO- https://github.com/caddyserver/caddy/releases/download/v2.7.6/caddy_2.7.6_linux_amd64.tar.gz | tar -xz && rm -f caddy_2.7.6_linux_amd64.tar.gz LICENSE README.md && chmod +x caddy && mv caddy /usr/local/bin/caddy
```
Be sure to modify `backend/etc/Caddyfile` replacing `notepad.mx` with your own domain,
and then run:
```shell
caddy start --config ./backend/etc/Caddyfile
```
## :closed_lock_with_key: How it works
- You login using a passphrase which produces a hash value of 32 bytes (or 64 characters in hex)
- First 16 bytes is your **authentication key** used in API calls when sending data back and forth
- Next 16 bytes is your **encryption key** used to encrypt that text data
- Encryption key never leaves your browser.
- All the notes are stored as encrypted files inside `storage/{storage_key}` where storage_key = `md5(authentication_key)`
See the drawing below:
This makes it so that no one besides you know the contents of your notes, or where they are stored on the server.
## :arrows_counterclockwise: Sharing Notes between instances
Notes created on one server are compatible with all other deployments of this application,
as long as passphrases are hashed using the same salt (`notepad.mx` by default as defined
inside `frontend/src/config.js`).
This makes it possible to import notes from one server to another, or host a backup mirror instance in case the main
instance gets shut down.
You can download all the notes created on the main **notepad.mx** instance here:
- https://notepad.mx/archive.tar.gz
extract everything to `backend/storage`, and now everyone using your application has access to those notes too.
There is also a command that does all that for you automatically:
```shell
docker compose exec -it backend sh -c "sh backend/bin/sync.sh"
```
## To-do list
- rewrite frontend to use TypeScript
- use websockets to better support multiple sessions editing same document scenarios
- add option to use Redis for storing notes
- ability to use this app via command line
- update the editor to allow subdivision of long text into multiple subsections via linebreaks
## Versions
If you want to continue using v1, go here:
https://github.com/Athlon1600/notepad/tree/v1.0.0-rc.1
## External Links
- https://hub.docker.com/r/athlon1600/notepad
- https://ricmoo.github.io/scrypt-js/
- http://aes.online-domain-tools.com/
- https://www.proxynova.com/tools/brute-force-calculator
- https://en.wikipedia.org/wiki/Base62