https://github.com/goodrequest/safe
Safe enables sharing confidential information with a limited number of views and overall lifetime.
https://github.com/goodrequest/safe
Last synced: about 2 months ago
JSON representation
Safe enables sharing confidential information with a limited number of views and overall lifetime.
- Host: GitHub
- URL: https://github.com/goodrequest/safe
- Owner: GoodRequest
- License: mit
- Created: 2023-12-07T10:35:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T14:14:15.000Z (over 1 year ago)
- Last Synced: 2025-06-11T23:39:19.196Z (9 months ago)
- Language: HTML
- Size: 66.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 
Safe
[](https://hub.docker.com/r/goodrequestcom/safe)
**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:
```bash
# 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**](https://bun.sh) documentation is available [here](https://bun.sh/docs).
[**Redis**](https://redis.io) documentation is available [here](https://redis.io/docs).
[**Docker**](https://www.docker.com) documentation is available [here](https://docs.docker.com).
[**NGINX**](https://www.nginx.com) documentation is available [here](https://nginx.org/en/docs/).
## License
**Safe** is released under the MIT license. See [LICENSE.md](./LICENSE.md) for details.