Python-powered system connection manager and mounts via SSH
System connection manager using Python which connects and mounts home directory through SSH
- PowerShell completion facilities
- Internationalization
- Full commands translation
- version.txt file to update version automatically
- Install and uninstall documentation
- Better way to connect through a configured bastion host
- Maybe is good idea to put 'ansible' package in the requirements... Since it is a really required requirement...
- Windows installation process
- Bastion host indication in "Connecting to..." message
- English texts
- break-system-packages parameter detection
- Wrong bastion port
- Default Ansible port support
- Wrong varaible name in config.py.template
- SSH bastion hosts support
- Better README.md format
- Internal --break-system-packages parameter in uninstall.py
- Code quality
- Codacy badge
- Code quality
- -v parameter to show version number
- host_id variable as it is redundant
- Posibility to load multiple inventories
- Wrong class variable name
- -L parameter to stablish a local SSH tunnel bind
- Some Eclipse / Pydev warnings
- Conversion to Python package
- Scripts to manage installation
- Scripts to mount and unmount home directory
- Conversion to library
- Initial script to establish a connection
Before you start using the 'conector' package, you need to configure it according to your needs. The configuration settings are stored in the conector/config.py file. Follow these steps to set up the configuration:
-
Navigate to the 'conector' directory where you cloned the repository.
-
Copy the
config.py.templatefile located in the 'conector' directory toconfig.py. -
Open the
config.pyfile using your preferred text editor. -
In the
config.pyfile, you will find a list of constants that need to be configured. Fill in the required information for each constant. For instance:SSH_KEY = 'path/to/your/ssh/key' DEFAULT_ANSIBLE_USER = 'your_ssh_user' INVENTORY_DIR_NAME = 'path/to/your/ansible/inventory/directory/or/file' VAULT_PASS_FILE = 'path/to/your/ansible/vault_pass/file'
Replace all the sample values with your specific values.
- Save the changes to the
config.pyfile and close the text editor.
Now the 'conector' package is configured and ready to use.
To install the 'conector' package, follow these steps:
- Make sure you have Python 3.6 or higher installed on your system. You can check your Python version by running the following command in your terminal:
python3 --versionIf you don't have Python installed, you can download it from the official Python website.
- It's recommended to create a virtual environment for the installation to avoid potential conflicts with other packages. You can do this by running the following commands:
python3 -m venv conector-env
source conector-env/bin/activate # On Windows, use 'conector-env\Scripts\activate'- Clone the 'Conector' repository from GitHub:
git clone https://github.com/Veltys/Conector.git- Navigate to the cloned repository's directory:
cd Conector- Install the 'conector' package using pip:
[ sudo ] pip install [ --break-system-packages ] .Note: Do not forget the final dot.
Now the 'conector' package should be installed on your system and ready to use.
Note: To exit the virtual environment after you've finished using the 'conector' package, simply run the following command:
deactivateKeep in mind that the normal uninstall process will leave some residue on the system. That is why a clean uninstall script is provided.
To uninstall the 'conector' package and remove the Bash autocompletion files, follow these steps:
- Navigate to the cloned repository's directory:
cd Conector- Run the following command, this will remove the 'conector' package and the associated bash autocompletion files:
[ sudo ] python3 uninstall.py [ --break-system-packages ]- To the official Ansible documentation, for the more-or-less enough Python API documentation
- To the official Python documentation, for obvious reasons