| 1 |
Installing and upgrading: |
| 2 |
========================= |
| 3 |
|
| 4 |
You can get the latest stable version of pwman3 from pypi:: |
| 5 |
|
| 6 |
$ pip install pwman3 |
| 7 |
|
| 8 |
Or you can install pwman3 cloning the repository and running:: |
| 9 |
|
| 10 |
$ git clone https://github.com/pwman3/pwman3.git |
| 11 |
$ cd pwman3 && pip install . |
| 12 |
|
| 13 |
Inside the extraced directory. At the moment pypi still does not have |
| 14 |
the latest version of pwman3. |
| 15 |
|
| 16 |
|
| 17 |
Upgrading from version 0.5.x |
| 18 |
---------------------------- |
| 19 |
|
| 20 |
If you used the 0.5.x version of ``pwman3`` your database is not compatible |
| 21 |
with the new 0.6.x and later versions of ``pwman3``. You need to export your database |
| 22 |
to a CSV from version 0.5.3 with:: |
| 23 |
|
| 24 |
pwman> export |
| 25 |
|
| 26 |
See ``help export`` when running pwman3 in version 0.5.3. |
| 27 |
Once exported you should rename your old database, to keep a backup of it. |
| 28 |
Then you can install pwman3 in version 0.6.x or later as described above. When finished |
| 29 |
you can import your passwords from the CSV to a new database with:: |
| 30 |
|
| 31 |
$ pwman3 -i path_to_your_file.csv \; |
| 32 |
|
| 33 |
The `\;` tells the importer that the file is semi-colon separated. |
| 34 |
When the import is done, start pwman3 with:: |
| 35 |
|
| 36 |
$ pwman3 |
| 37 |
|
| 38 |
If the import was success, erase the CSV file, which contains your passwords |
| 39 |
in clear text. |
| 40 |
|
| 41 |
Upgrading from version 0.6 or later: |
| 42 |
------------------------------------ |
| 43 |
|
| 44 |
Once again the latest release (version 0.9) breaks compatibility with earlier |
| 45 |
versions. As a user you might consider this an annoyance, which is understandable. |
| 46 |
However, older Pwman3 version used a very old cryptography library which is |
| 47 |
no longer actively maintained. With the migration of the code base to use |
| 48 |
the cryptography_ library, there was a necessary change of the underlying |
| 49 |
encryption algorithm. AES encryption with ECB mode was the old algorithm used, |
| 50 |
which is by now considered outdated, and it was replaced with Fernet encryption |
| 51 |
which is considered best practice. |
| 52 |
|
| 53 |
To upgrade, follow the path described above to export your database to a CSV, |
| 54 |
and the import it. |
| 55 |
|
| 56 |
A Note about Python versions |
| 57 |
---------------------------- |
| 58 |
|
| 59 |
Earlier versions of Pwman3 supported both Python2 and Python3 versions. This |
| 60 |
created a bit of an effort for maintaining version compatablity, and served |
| 61 |
as a migration path for future versions. Python 3 has been around now for quite |
| 62 |
a while, and soon enough, Python2 support will end. Python 3 is mature enough, |
| 63 |
and offers many improvements for developers. Python 3.4 is included in all major |
| 64 |
modern Linux distributions. |
| 65 |
If you use a certain enterprise Linux versions which does not ship Python 3.3 |
| 66 |
or later, the process for installing a newer Python versions is pretty straight |
| 67 |
forward and very well documented. You should opt for using newer Python versions |
| 68 |
for all your software if possible. |
| 69 |
|
| 70 |
If you want to learn more about why Python 3, see the following `Python3 statement`_ |
| 71 |
|
| 72 |
Database versions |
| 73 |
----------------- |
| 74 |
|
| 75 |
The current version of Pwman3 is tested with Postgresql-9.3, MySQL-5.5, |
| 76 |
MongoDB 2.6.X and SQLite3. |
| 77 |
|
| 78 |
The required python drivers are: |
| 79 |
|
| 80 |
* pymysql version 0.6.6 |
| 81 |
* psycopg2 version 2.6 |
| 82 |
* pymongo version 2.8 |
| 83 |
|
| 84 |
.. _cryptography: https://cryptography.io |
| 85 |
.. _Python3 statement: https://python3statement.github.io/ |