Self-hosted service for secrets sharing
Find a file
2024-12-26 22:52:41 +01:00
conf Rename project to pssecret 2024-12-25 12:40:57 +01:00
pssecret Atomic get and deletion of secret data 2024-12-26 22:52:41 +01:00
.flake8 Rename project to pssecret 2024-12-25 12:40:57 +01:00
.gitignore Ignoring local Neovim configuration 2024-12-26 20:14:32 +01:00
.pre-commit-config.yaml Rename project to pssecret 2024-12-25 12:40:57 +01:00
CONTRIBUTING.md Migrated to poetry 2024-12-25 18:35:01 +01:00
LICENSE Added BSD-3 license 2022-06-10 01:46:31 +03:00
poetry.lock Bump dependencies versions 2024-12-26 20:13:38 +01:00
pyproject.toml Bump dependencies versions 2024-12-26 20:13:38 +01:00
README.md Typo fix 2024-12-26 19:41:54 +01:00

Pssecret

Code style: black

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

For faster performance, install application with hiredis support.

$ pipx install pssecret[hiredis]

Running Pssecret server

Make sure you have the Redis service running.

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

$ pssecret

Configuration

Configuration is done through config file. By default, path is /etc/pssecret/pssecret.toml. You can override this by setting environment variable PSSECRET_CONF_FILE value to actual file location, e.g.:

$ PSSECRET_CONF_FILE=/home/user/.conf/pssecret.toml pssecret

You can find all available configuration options in the example file, located at conf/pssecret.toml.example under Git root.