secret

README

Secure File Sharing Application with Docker

This repository provides a secure file-sharing solution using yopass behind an NGINX reverse proxy, with HTTPS enabled via custom TLS certificates and caching support through Memcached.

Table of Contents

• Overview
• File Structure
• Dependencies
• Setup
• How It Works
• Customizations
• Troubleshooting
• Contributions
• License

---

Overview

This application uses the following components:

• Yopass: A secure way to share secrets or files with expiration, backed by Memcached for storage.
• NGINX: Acts as a reverse proxy for secure HTTPS connections and redirects traffic to Yopass.
• Memcached: Provides in-memory caching to store temporary data for Yopass.
• TLS Certificates: Ensures encrypted communication over HTTPS.

---

File Structure

docker/
├── certs/
│   ├── CASERIS.crt             # Custom SSL certificate to avoid issuer errors
│   ├── secret.securit.fr.crt   # Public TLS certificate for the domain
│   ├── secret.securit.fr.pem   # Private key for the TLS certificate
├── nginx/
│   ├── nginx.conf              # Configuration file for the NGINX reverse proxy
docker-compose.yml              # Defines the services: Memcached, Yopass, and NGINX

---

Dependencies

• Docker: Version 27.3.1 or later
• Docker Compose: Version 2.29.7 or later
• Custom domain pointing to your server (e.g., secret.securit.fr)

---

Setup

1. Clone the Repository

git clone git@gitlab.securit.fr:intranet/yopass.git
cd yopass