Skip to content

Latest commit

 

History

History
337 lines (209 loc) · 16.5 KB

README.md

File metadata and controls

337 lines (209 loc) · 16.5 KB
Raw

Password Pusher Front Page

Simple & Secure Password Sharing with Auto-Expiration of Shared Items

Github CI Dependencies Status Semantic Versions License

Give your users the tools to be secure by default.

Password Pusher is an opensource application to communicate passwords over the web. Links to passwords expire after a certain number of views and/or time has passed.

Hosted at pwpush.com but you can also easily run your own private instance with just a few steps.

  • Easy-to-install: Host your own via Docker, a cloud service or just use pwpush.com
  • Opensource: No blackbox code. Only trusted, tested and reviewed opensource code.
  • Versatile: Push passwords, text, files or URLs that autoexpire and self delete.
  • Audit logging: Track and control what you've shared and see who has viewed it.
  • Encrypted storage: All sensitive data is stored encrypted and deleted entirely once expired.
  • Host your own: Database backed or ephemeral, easily run your own instance isolated from the world.
  • JSON API: Raw JSON API available for 3rd party tools or command line via curl or wget.
  • Command line interface: Automate your password distribution with CLI tools or custom scripts.
  • Logins: Invite your colleagues and track what is pushed and who retrieved it.
  • Internationalized: 28 language translations are bundled in. Easily selectable via UI or URL
  • Themes: 26 themes bundled in courtesy of Bootswatch. Select with a simple environment variable.
  • Unbranded delivery page: No logos, superfluous text or unrelated links to confuse end users.
  • Customizable: Change text and default options via environment variables.
  • Light & dark themes: Via CSS @media integration, the default site theme follows your local preferences.
  • Rebrandable: Customize the site name, tagline and logo to fit your environment.
  • Custom CSS: Bundle in your own custom CSS to add your own design.
  • 10 Years Old: Password Pusher has securely delivered millions and millions of passwords in its 10 year history.
  • Actively Maintained: I happily work for the good karma of the great IT/Security community.
  • Honest Software: Opensource written and maintained by me with the help of some great contributors. No organizations, corporations or evil agendas.

💌 --> Sign up for the newsletter to get updates on big releases, security issues, new features, integrations, tips and more.

Password Pusher is also on on Twitter, Gettr and on Facebook

⚡️ Quickstart

→ Go to pwpush.com and try it out.

or

→ Run your own instance with one command: docker run -d -p "5100:5100" pglombardo/pwpush-ephemeral:release then go to http://localhost:5100

or

→ Use one of the 3rd party tools that interface with Password Pusher.

💾 Run Your Own Instance

Note: Password Pusher can be largely configured by environment variables so after you pick your deployment method below, make sure to read the configuration page. Take particular attention in setting your own custom encryption key which isn't required but provides the best security for your instance.

On Docker

Docker images of Password Pusher are available on Docker hub.

➜ ephemeral Temporary database that is wiped on container restart.

docker run -d -p "5100:5100" pglombardo/pwpush-ephemeral:release

Learn more

➜ using an External Postgres Database Postgres database backed instance.

docker run -d -p "5100:5100" pglombardo/pwpush-postgres:release

Learn more

➜ using an External MariaDB (MySQL) Database Mariadb database backed instance.

docker run -d -p "5100:5100" pglombardo/pwpush-mysql:release

Learn more

Note: The latest Docker container tag builds nightly off of the latest code changes and can occasionally be unstable. Always use the 'release' or version'd tags if you prefer more stability in releases.

With Docker Compose

➜ One-liner Password Pusher with a Postgres Database

curl -s -o docker-compose.yml https://raw.githubusercontent.com/pglombardo/PasswordPusher/master/containers/docker/pwpush-postgres/docker-compose.yml && docker compose up -d

➜ One-liner Password Pusher with a MariaDB (MySQL) Database

curl -s -o docker-compose.yml https://raw.githubusercontent.com/pglombardo/PasswordPusher/master/containers/docker/pwpush-mysql/docker-compose.yml && docker compose up -d

On Kubernetes

Instructions and explanation of a Kubernetes setup can be found here.

On Kubernetes with Helm

A basic helm chart with instructions can be found here.

On Microsoft Azure

There used to be a 3rd party blog post with instructions but it's been deleted. If anyone has instructions they would like to contribute, it would be greatly appreciated.

See issue #277

On Heroku

One click deploy to Heroku Cloud without having to set up servers.

Deploy

This option will deploy a production Password Pusher instance backed by a postgres database to Heroku. Heroku used to offer free dynos but that is no longer the case from November 28, 2022. Hosting charges will be incurred.

On PikaPods

One click deploy to PikaPods from $1/month. Start free with $5 welcome credit.

Run on PikaPods

With Nginx

See the prebuilt Docker Compose example here.

From Source

I generally don't suggest building this application from source code for casual use. The is due to the complexities in the toolset across platforms. Running from source code is best when you plan to develop the application.

For quick and easy, use the Docker containers instead.

But if you're resolute & brave, continue on!

Dependencies

  • Ruby 3.0 or greater
  • Recent Node.js stable & Yarn
  • Compiler tools: gcc g++ make
  • Other: git

SQLite3 backend

  • Make sure to install sqlite3 development libraries: apt install libsqlite3-dev sqlite3
git clone git@github.com:pglombardo/PasswordPusher.git
cd PasswordPusher
gem install bundler

export RAILS_ENV=private

bundle config set with 'sqlite'
bundle config set --local deployment 'true'
bundle install --without development production test
./bin/rails assets:precompile
./bin/rails db:setup
./bin/rails server --environment=private

Then view the site @ http://localhost:5100/.

Postgres, MySQL or Mariadb backend

  • Make sure to install related database driver development libraries: e.g. postgres-dev or libmariadb-dev
git clone git@github.com:pglombardo/PasswordPusher.git
cd PasswordPusher
gem install bundler

export RAILS_ENV=production

# Update the following line to point to your Postgres (or MySQL/Mariadb) instance
DATABASE_URL=postgresql://passwordpusher_user:passwordpusher_passwd@postgres:5432/passwordpusher_db

bundle config set with 'postgres' # or 'mysql'
bundle install --without development private test
./bin/rails assets:precompile
./bin/rails db:setup
./bin/rails server --environment=production

Then view the site @ http://localhost:5100/.

🔨 3rd Party Tools

Command Line Utilities

Libraries & APIs

  • oyale/PwPush-PHP: a PHP library wrapper to easily push passwords to any Password Pusher instance

Android Apps

Application Integrations

See also the Tools Page on pwpush.com.

📡 The Password Pusher API

🇮🇹 Internationalization

Password Pusher is currently available in 28 languages with more languages being added often as volunteers apply.

From within the application, the language is selectable from a language menu. Out of the box and before any language menu selection is done, the default language for the application is English.

Changing the Default Language

The default language can be changed by setting an environment variable with the appropriate language code:

PWP__DEFAULT_LOCALE=es

For more details, a list of supported language codes and further explanation, see the bottom of this configuration file.

🛟 Help Out

pwpush.com is hosted on Digital Ocean and is happily paid out of pocket by myself for more than 10 years.

But you could help out greatly by signing up to Digital Ocean with this link (and get $200 credit). In return, Password Pusher gets a helpful hosting credit.

tldr; Sign up to Digital Ocean with this link, get a $200 credit for free and help Password Pusher out.

DigitalOcean Referral Badge

📼 Credits

Translators

Thanks to our great translators!

If you would like to volunteer and assist in translating, see this page.

Name Language
Oyale Catalan
Finn Skaaning Danish
Mihail Tchetchelnitski Finnish
Thibaut French
Thomas Wölk German Github, Twitter
Martin Otto German
Robin Jørgensen Norwegian
Łukasz Polish
Jair Henrique Portuguese
Fabrício Rodrigues Portuguese
Ivan Freitas Portuguese
Sara Faria Portuguese
Oyale Spanish
johan323 Swedish
Fredrik Arvas Swedish
Pedro Marques European Portuguese

Also thanks to translation.io for their great service in managing translations. It's also generously free for opensource projects.

Containers

Thanks to:

Other

Thanks to:

...and many more. See the Contributors page for more details.

🛡 License

License

This project is licensed under the terms of the Apache License 2.0 license. See LICENSE for more details.

📃 Citation

@misc{PasswordPusher,
  author = {Peter Giacomo Lombardo},
  title = {An application to securely communicate passwords over the web. Passwords automatically expire after a certain number of views and/or time has passed.},
  year = {2022},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/pglombardo/PasswordPusher}}
}