github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sysadm server handbook section addition

Browse Source 
- Added WIP section "Bridge System Initialization" to server handbook
- Divided instructions into two methods - one for complete ground up and another for allowing user access to an established network.
- Began clarifying and testing instructions.
This commit is contained in:
Mrt134
2016-05-31 15:03:32 -04:00
parent 0c6ef4dd85
commit 2f5321ea75
1 changed files with 48 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/basics.rst
View File

@@ -45,6 +45,54 @@ Please note that it is possible to enable SysAdm™ to function in both states s
% sudo sysrc -f /etc/rc.conf sysadm_rest_enable="YES"
% sudo service sysadm-rest start
.. _bridge sysinit:
Bridge System Initialization
----------------------------
Initializing the bridge system will be described through two different methods: ground-up initialization and client/system administration. Ground-up will be useful for users who have full control over their network and are building and initializing SysAdm™ from scratch. The client/system administration method assumes a user is attempting to connect to an existing bridge which a system administrator controls.
**Ground-Up Initialization**
.. note:: This will require the latest server/bridge/client from source (on various systems as necessary)
1. (Client) If you have a pre-existing SSL certificate bundle for the client, it will need to be removed (:command:`~/.config/PCBSD/sysadm_ssl*`). Then create a new SSL certificate bundle within the client after a restart, as the client will now create several different certificates.
2. (Client) Once the new SSL certs are created, open up the "Setup SSL -> View Certificates" page/tab in the connection manager, and click the "Save to file" button on both certs. This will export your public SSL key in file form, and place the files either in your Desktop folder or in your home directory (depending on the system/OS).
3. (Server) Run :command:`sudo sysadm-binary bridge_export_key [optional absolute file path]` to export the public SSL key that the server will use to authenticate with the bridge (it helps to dump it to a file like "/tmp/sysadm-server-to-bridge.key").
4. (Bridge) Run (as the user which will be running the bridge) :command:`sysadm-bridge -import_ssl_file <nickname> <filepath>` on the server -> bridge and client -> bridge key files that were exported earlier. If needed, these files can easily be transferred between systems.
5. (Bridge) If the bridge is not already running, start it now. Step 4 can be performed while the bridge is active without any adverse effects.
6. (Server) Run :command:`sudo sysadm-binary -import_ssl_key <username> <filepath> [<email>]` to import the client -> server SSL key file. This grants an individual with that specific SSL authorization the same permissions as <user>.
7. (Server) Run :command:`sudo sysadm-binary bridge_add <nickname> <URL>` to point the server at a bridge. The bridge runs on **port 12149** by default, so you will probably need to add a ":12149" to the end (example: 127.0.0.1:12149).
8. (Server) If necessary, start/restart the server. If you view the log (/var/log/sysadm-server-ws.log) you should see some messages about connecting to the bridge.
9. (Client) Open up the connection Manager and create a connection to the bridge with the same URL as the one you just used for the server (Ex: 127.0.0.1:12149). The username/password are not needed, but the GUI will still ask for them anyway so you can just give it dummy info right now so you can test/connect.
The bridge will show up in the menu tree with a different icon, and will have a sub-menu of connections within it. If you click on the bridged system, it will open the standard UI but connected to that system through the bridge.
**Client/System Administration**
This method reflects a different scenario in which a user requests bridge access from a system administrator, who then adds the user's key to an existing bridge:
Two files are output client to bridge and client to server
**User:**
1. In the SysAdm client, create a SSL certificate bundle. Skip this step if the bundle has already been created.
2. Open the "Setup SSL -> View Certificates" page/tab in the connection manager, and click the "Save to file" button on both certificates. This will export your public SSL keys in file form, and place the files either in your Desktop folder or in your home directory (depending on the system/OS).
3. Contact the bridge's system administrator, requesting access to the bridge and providing the public SSL keys saved in step 1.
**System Administrator:**
1. Once a user request for bridge access is received along with the user generated public SSL keys, the administrator needs to add the keys to the server and bridge:
a. Export the user submitted keys to their respective locations: client --> bridge and server --> bridge.
b. On the bridge, run :command:`sysadm-bridge -import_ssl_file <nickname> <filepath>` on the server -> bridge and client -> bridge key files that were exported earlier. If needed, these files can easily be transferred between systems.
c. Back on the server, run :command:`sudo sysadm-binary -import_ssl_key <username> <filepath> [<email>]` to import the client -> server SSL key file. This grants an individual with that specific SSL authorization the same permissions as <user>.
2. Provide the bridge URL to the user.
**User:**
1. In the SysAdm client, open up the connection Manager and create a connection to the bridge with the same URL as the one provided by the system administrator (Ex: 127.0.0.1:12149).
2. Provide a username/password if necessary.
.. _adddoc: