Self-hosted service for secrets sharing

Find a file

Ivan Golikov de52702f8d Small wording change in README		2025-01-01 20:10:28 +01:00
pssecret_server	Renamed project to pssecret-server	2025-01-01 20:03:46 +01:00
tests	Renamed project to pssecret-server	2025-01-01 20:03:46 +01:00
.gitignore	Added aider files to .gitignore	2025-01-01 20:10:12 +01:00
.pre-commit-config.yaml	Integration tests (#3 )	2025-01-01 18:18:38 +00:00
CONTRIBUTING.md	Renamed project to pssecret-server	2025-01-01 20:03:46 +01:00
LICENSE	Added BSD-3 license	2022-06-10 01:46:31 +03:00
poetry.lock	Integration tests (#3 )	2025-01-01 18:18:38 +00:00
pyproject.toml	Fixed license name in pyproject.toml	2025-01-01 20:09:53 +01:00
README.md	Small wording change in README	2025-01-01 20:10:28 +01:00

README.md

Pssecret server

Pssecret is self-hosted service to share secrets (like passwords) with somebody over the network, but don't want them to appear in chats, unencrypted e-mails, etc.

This service tries to be as anonymous as possible. The only personal information that will be stored on a server will be IP address of the client that made request to the server.

Service is built with Python, FastAPI and is using Redis for data storage.

Installation

Requirements

Python 3.11+
Redis
Python development libraries (optional, only needed for hiredis module installation)

How to install

The recommended installation method is with the pipx

$ pipx install pssecret-server

For better performance, install application with hiredis support.

$ pipx install pssecret-server[hiredis]

Running Pssecret server

Make sure you have the Redis service running.

After installation is done, you can start pssecret server with pssecret-server command. The web server will be started with uvicorn ASGI web server.

$ pssecret-server

Configuration

Configuration is done via environment variables.

Environment variables:

REDIS_URL: URL for Redis access. Check what values are supported here.

You can also declare these variables in a .env file in the working directory.