Skip to content

Safe enables sharing confidential information with a limited number of views and overall lifetime.

License

Notifications You must be signed in to change notification settings

GoodRequest/Safe

Repository files navigation

GoodRequest, s.r.o.Safe

dockeri.co

Safe enables sharing confidential information with a limited number of views and overall lifetime.

Features

🕸️ Web Native frontend build with pure HTML, CSS and JS.
🪶 Simple and lightweight single-file backend with Bun.
🔏 Fast and secure data management with Redis.

A (Very) Quick Start

Deploy the app in a Docker Compose stack with (non-persistent) Redis and (reverse proxy) NGINX.

Once deployed, open the app, input the data, stash it and share the generated Safe link as needed.

Optionally, limit access to an internal route with the help of NGINX allow and deny configuration.

Security 101

Limit secret information view count and lifetime as much as possible.

Try not to share sets of secrets, or unnecessarily note their purpose.

Share the generated links only through secure channels. Stay Safe.

Environment variables

To make Safe run smoothly, add these environment variables to the container configuration:

# Disables Bun telemetry
DO_NOT_TRACK=1

# Enables connections to the Redis server
REDIS_URL=

# Path segment used to differentiate
# between Company (e.g. VPN restricted) 
# and Client (public) Safe through e.g.
# NGINX location routing configuration
INTERNAL_PATH=

# Enables file sharing over AWS S3 (1/4)
AWS_DEFAULT_REGION=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_S3_BUCKET_NAME=

Additional Resources

Bun Bun documentation is available here.

Redis Redis documentation is available here.

Docker Docker documentation is available here.

NGINX NGINX documentation is available here.

License

Safe is released under the MIT license. See LICENSE.md for details.

About

Safe enables sharing confidential information with a limited number of views and overall lifetime.

Resources

License

Stars

Watchers

Forks

Packages

No packages published