betternote's Introduction

✨ betternote - Simple and secure one-time note sharing service

✨ betternote - Simple and secure one-time note sharing service

Screenshots

(Not much to show off, right?)

Why?

Sometimes you just have to send that plain-text password to your friend or colleague, right? That's why this tool exists.

Server encrypts your data, saves it to Redis and you're left with one-time link with decryption key embedded into it!

Inspiration came from dnote project.

Stack

Made with dotnet, Redis, pure JS (with aes-js) and ❤️.

Deployment

Intended to be deployed with docker-compose. This repo has two deployment configs:

docker-compose.yml - default deployment example.
docker-compose-build.yml - deployment with build (latest version from source).

Deployment: HTTP vs HTTPS

You probably should deploy this service with a reverse proxy of some kind that will provide HTTPS. Hosting this page on HTTP will not only decrease security but also forces frontend to use outdated clipboard copy method.

Configuration

Environment variable	Meaning	Default value	Comment
ASPNETCORE_ENVIRONMENT	Server environment, better be left as it is.	`Production`
ASPNETCORE_URLS	Interface bind URL with port	`http://0.0.0.0:5000`	Server will bind on all interfaces on port 5000.
RedisDatabaseId	Redis database ID	`-1`
RedisHost	Redis hostname, without port (6379 expected)	`redis`
SecretExpiryInMinutes	Secret expiry time, in minutes	`720`	12 hours by default. Keep in mind that notes on your server are going to be burned after the first read. This sets expiry time for notes that weren't read.

Contribution

I would be glad! Please do.

Attribution

This project uses icon made by pictranoosa. Thank you!

betternote's People

Contributors

Stargazers

Watchers

betternote's Issues

Docker examples spaces in newline

Hey,

in the docker examples the lines should be empty.
https://github.com/0x25CBFC4F/betternote/blob/217a08c627b309ca1e932e5349deb0cffe5f5c19/docker-compose-customnet.yml#L21C1-L21C5

SecretExpiryInMinutes does not work

You can set 12 hours as the standard time provided in the environment but your link will expire just after the first read.

failed to solve: failed to read dockerfile

[+] Building 0.1s (2/2) FINISHED
 => [betternote internal] load .dockerignore                                                                                                                                                                                                                                                                            0.0s
 => => transferring context: 2B                                                                                                                                                                                                                                                                                         0.0s
 => [betternote internal] load build definition from Dockerfile                                                                                                                                                                                                                                                         0.0s
 => => transferring dockerfile: 2B                                                                                                                                                                                                                                                                                      0.0s
failed to solve: failed to read dockerfile: open /var/lib/docker/tmp/buildkit-mount1063389014/Dockerfile: no such file or directory

after copying your docker-compose, and starting the container:

$ docker compose start
service "redis" has no container to start

Client: Docker Engine - Community
Version: 24.0.5
API version: 1.43
Go version: go1.20.6
Git commit: ced0996
Built: Fri Jul 21 20:35:45 2023
OS/Arch: linux/amd64
Context: default

Server: Docker Engine - Community
Engine:
Version: 24.0.5
API version: 1.43 (minimum version 1.12)
Go version: go1.20.6
Git commit: a61e2b4
Built: Fri Jul 21 20:35:45 2023
OS/Arch: linux/amd64
Experimental: false
containerd:
Version: 1.6.22
GitCommit: 8165feabfdfe38c65b599c4993d227328c231fca
runc:
Version: 1.1.8
GitCommit: v1.1.8-0-g82f18fe
docker-init:
Version: 0.19.0
GitCommit: de40ad0

Recommend Projects

0x25cbfc4f / betternote Goto Github PK