Skip to content
This repository has been archived by the owner on Mar 13, 2019. It is now read-only.

Latest commit

 

History

History
159 lines (117 loc) · 3.52 KB

README.md

File metadata and controls

159 lines (117 loc) · 3.52 KB
Raw

Build Status SensioLabsInsight Gitter

About

PWX allows you to set up your own password exchange service to share passwords via a temporary link.

For more information please check out my blog

Example

https://pwx.michaelthessel.com

Installation

Download the current stable release here or clone the repository.

Install dependencies:

# php composer.phar install

Create configuration file and adjust according to your environment:

# cp app/config.php.sample app/config.php

Create the database schema:

# app/console orm:schema-tool:create

Web server configuration

The Silex Documentation has example configurations for Apache, nginx, IIS & Lighttpd.

Update

Download the latest source code.

If you are updating to a newer version follow these steps.

Update dependencies:

# php composer.phar update

Update the database schema:

# app/console orm:schema-tool:update --force

Translations

Currently:

  • English (en)
  • Spanish (es)
  • Esperanto (eo)
  • and German (de)

are supported by PWX. Please set locale according to your requirements in the configuration. I'm happy to accept pull requests for additional translations.

You can use a GET parameter when linking to PWX. I.e.

https://example.com?locale=es

This allows for one instance of PWX dynamically being accessed in different languages.

Themes

PWX supports all Bootswatch themes. You can adjust the appearance of the application to your liking by a simple config switch.

Developers

PWX uses the Robo task runner. After making changes to the JS or CSS files run:

# vendor/bin/robo build

to minify and concatenate the files.

Alternatively you can run:

# vendor/bin/robo watch

while developing which will automatically generate the minified and concatenated assets when style or script files are changed.

To run the integrated test suite please run:

# vendor/bin/phpunit

API

PWX offers a simple API with the following endpoints:

Save an entry

Request Methoud: POST
End Point: https://example.com/api
Params:
    userName: string (default: "")
    password: string (reqired)
    comment: string (default: "")
    expires: int (time in s from when the entry will expire, min: 1h, max: 30days, default: 3600)
    oneTimeView: bool (whether or not the entry will be deleted after viewing it once, default: false)
Response:
    hash string (id of entry)

Retrieve an entry

Request Methoud: GET
End Point: https://example.com/api/[hash]
Params:
    n/a
Response:
    hash: string
    userName: string
    password: string
    comment: string

Delete an entry

Request Methoud: DELETE
End Point: https://example.com/api/[hash]
Params:
    n/a
Response:
    n/a

Warning

You will be responsible to secure your environment. The author of this software takes no responsiblity for any damage as a result of using this software.