Git
/
ssh-audit
mirror of https://github.com/jtesta/ssh-audit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated packaging instructions and merged Windows instructions.

This commit is contained in:
Joe Testa 2020-10-28 21:01:47 -04:00
parent 81ae0eb8f7
commit 75be333bd2
2 changed files with 33 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
PACKAGING
View File

@ -1,3 +1,23 @@
= Windows =
An executable can only be made on a Windows host because the PyInstaller tool (https://www.pyinstaller.org/) does not support cross-compilation.
On a Windows machine, do the following:
1.) Install Python v3.7.x from https://www.python.org/. (As of this writing v3.8.0 isn't supported.) To make life easier, check the option to add Python to the PATH environment variable.
2.) Using pip, install pyinstaller and colorama:
pip install pyinstaller colorama
3.) Create the executable with:
cd src\ssh_audit
rename ssh_audit.py ssh-audit.py
pyinstaller -F --icon ..\..\windows_icon.ico ssh-audit.py
---
= PyPI =
To create package and upload to test server:
@ -31,13 +51,23 @@ $ pip3 install ssh-audit
To create the snap package, run a fully-updated Ubuntu Server 20.04 VM.
As root, run (leave all options default):
Install pre-requisites with:
# lxd init
$ sudo apt install make snapcraft
$ sudo snap install review-tools
Initialize LXD (leave all options default):
$ sudo lxd init
Bump the version number in snapcraft.yaml. Then run:
# make -f Makefile.snap
$ make -f Makefile.snap
Upload the snap with:
$ snapcraft login
$ snapcraft upload --release=stable ssh-audit_*.snap
----

21
windows_build.txt
View File

@ -1,21 +0,0 @@
Below are notes for creating a Windows executable.
An executable can only be made on a Windows host because the PyInstaller tool (https://www.pyinstaller.org/) does not support cross-compilation.
On a Windows machine, do the following:
1.) Install Python v3.7.x from https://www.python.org/. (As of this writing v3.8.0 isn't supported.) To make life easier, check the option to add Python to the PATH environment variable.
2.) Using pip, install pyinstaller and colorama:
pip install pyinstaller colorama
3.) Create the executable with:
cd src\ssh_audit
rename ssh_audit.py ssh-audit.py
pyinstaller -D --icon ..\..\windows_icon.ico --add-data policies;policies ssh-audit.py
4.) Rename the "dist\ssh-audit\" folder to "dist\ssh-audit vX.X.X\"
5.) Zip the "dist\ssh-audit vX.X.X\" folder and name it "windows_ssh-audit_vX.X.X.zip" (hint: zip windows_ssh-audit_vX.X.X.zip -r "ssh-audit vX.X.X").