README
¶
ServerAuth Agent
This repository contains the source code for the ServerAuth Agent. A small Go based package that is used to synchronize your account SSH keys. Please note that to use this you'll need to first sign up for an account at https://serverauth.com
In most cases you can use the installer provided inside your ServerAuth account, which obtains the latest stable release of the agent from Github. However if you'd prefer to build the package from source, please see below.
Documentation
Our official documentation can be found at https://docs.serverauth.com, including documentation on building the agent from source.
System Requirements
Whilst the ServerAuth Agent is a fairly small and minimal package, it does have a few requirements. The first of which is our list of supported operating systems.
Whilst the agent is likely to work fine on other *nix based systems, these are the ones we currently officially support:
- CentOS 7
- CentOS 6
- Debian 10 (Buster)
- Debian 9 (Stretch)
- Debian 8 (Jessie)
- Debian 7 (Wheezy)
- Fedora 30
- Fedora 29
- Fedora 28
- Ubuntu 18.04
- Ubuntu 16.04
Permissions
The ServerAuth Agent must be run as a high-level user, with permission to modify files owned by another user.
It is assumed that the agent will be running as the root user, however if you are running as another user and have allocated the correct passwordless sudo permissions then you can modify the system cron job, or can manually trigger the serverauth sync command.
Available Commands
The agent includes a number of commands. These include the ability to add a new system account, remove an existing system account, and trigger a manual sync of all accounts.
Details on each command can be returned by running serverauth --help from command line.
Support
General Support
Support for using ServerAuth can be obtained via our docs site at https://docs.serverauth.com, or by clicking the help link inside your ServerAuth account.
Agent Bug Reports & Feature Requests
If you've found a bug in the agent, or would like to request a new feature, please open a ticket, providing as much detail as possible (e.g operating system, agent version, etc).
Please do not provide any personal ServerAuth account details when opening an issue as these are publicly accessible.
Documentation
¶
Overview ¶
Copyright © 2019 ServerAuth.com <info@serverauth.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories