diff --git a/README.md b/README.md index 9a429c0..03efdeb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,78 @@ -**sysPass** is a powerful GPLv3 web password manager for business and personal use. See more at http://syspass.org +# About -These images are based on Debian 8 (Jessie), Apache 2.4 webserver with PHP 5.6 module and MySQL 5.5. **No compilation stuff done**. +**sysPass** is a powerful GPLv3 web password manager for business and personal use. -### Stable -The best way to get it running is by installing through docker-compose. You will get a fully working sysPass container with its database. You can get the compose file from https://github.com/nuxsmin/docker-syspass and then... +See more at https://syspass.org - wget https://raw.githubusercontent.com/nuxsmin/docker-syspass/master/docker-compose.yml - docker-compose -p syspass up -d +**No compilation stuff done** + +## 2.1 release + +These images are based on Debian 8 (Jessie), Apache 2.4 webserver with PHP 5.6 module and MySQL 5.5 + +--- + +### Production +The best way to get it running is by installing through docker-compose. You will get a fully working sysPass environment with its database. + +You can get the compose file from https://github.com/nuxsmin/docker-syspass and then: + +``` +$ wget https://raw.githubusercontent.com/nuxsmin/docker-syspass/master/docker-compose.yml +$ docker-compose -p syspass up -d +``` + +Please take into account that you will need to setup a database if you choose to build the sysPass-only container. + +### Development + +If you want to test/develop the current release, please deploy it from https://github.com/nuxsmin/docker-syspass/tree/master/sysPass-dev through docker-compose: + +``` +$ wget https://raw.githubusercontent.com/nuxsmin/docker-syspass/master/sysPass-dev/docker-compose.yml +$ docker-compose -p syspassdev up -d +``` + +or pull it: + +``` +$ docker run --name sysPass-app-devel nuxsmin/docker-syspass:devel +``` + +Please take into account that you will need to setup a database if you choose to build the sysPass-only container. + + +## 3.0-beta release + +These images are based on Debian 9 (Stretch), Apache 2.4 webserver with PHP 7.0 module and MariaDB 10.1 + +--- + +### Testing +The best way to get it running is by installing through docker-compose. You will get a fully working sysPass environment with its database. + +You can get the compose file from https://github.com/nuxsmin/docker-syspass/tree/3.0 and then: + +``` +$ wget https://raw.githubusercontent.com/nuxsmin/docker-syspass/3.0/docker-compose.yml +$ docker-compose -p syspass up -d +``` Please take into account that you will need to setup a database if you choose to build the sysPass-only container. ### Development -If you want to test/develop the latest sysPass development, please deploy it from https://github.com/nuxsmin/docker-syspass/master/sysPass-dev through docker-compose ``docker-compose -p syspassdev up -d`` or pull it ``docker run --name sysPass-app-devel nuxsmin/docker-syspass:devel``. **Don't forget to setup a database if you pulled it.** +If you want to test/develop the current release, please deploy it from https://github.com/nuxsmin/docker-syspass/tree/3.0/sysPass-dev through docker-compose: + +``` +$ wget https://raw.githubusercontent.com/nuxsmin/docker-syspass/3.0/sysPass-dev/docker-compose.yml +$ docker-compose -p syspassdev up -d +``` + +or pull it: + +``` +$ docker run --name sysPass-app-devel nuxsmin/docker-syspass:3.0-beta-dev +``` + +Please take into account that you will need to setup a database if you choose to build the sysPass-only container.