Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Docker

Screenshots

Screenshot (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!

About

Simple, fast secure note sharing service.

Resources

Stars

22 stars

Watchers

1 watching

Forks

Used by

Contributors

Languages