Enabling authentication in your EveBox configuration file:
authentication: required: true type: usernamepassword
And enabling the configuration database either with the
-Dcommand line option or the
data-directoryconfiguration file setting.
If using the RPM or Debian packages AND starting EveBox with
systemd, the data-directory is already configured to be
For the rest of this documentation,
be used as the data-directory.
Starting the Server with Authentication Enabled¶
If EveBox was installed with a RPM or Debian package and started with
systemd, it is already setup with a configuration database, just
enable authentication in
/etc/evebox/evebox.yaml (you may first
Otherwise, if you are manually starting EveBox you must use the
command line option to set the data directory where the configuration
database can be stored:
./evebox server -D ~/.evebox/
EVEBOX_DATA_DIRECTORY environment variable can also
be used to set the data directory.
Adding a User¶
Adding users is done with the config tool, for example:
evebox config -D /var/lib/evebox users add --username joe
RPM and Debian package installations of EveBox setup
/var/lib/evebox to be owned by the user
evebox, so you
may need use sudo to add users, for example:
sudo -u evebox config -D /var/lib/evebox users add
or as root:
sudo evebox config -D /var/lib/evebox users add
EveBox can authenticate against GitHub using Oauth2. It is required
that the user is first created in the configuration database, but with
--github-username parameters, for example:
evebox config -D /var/lib/evebox users add --username jason \ --github-username jasonish
You will be prompted with user details retrieved from GitHub and must provide confirmation before the user is actually added to the database.
GitHub must also be enabled in the configuration file with the
callback URLs configured.
client-secret are obtained from
GitHub by registering a new application under your
“Developer settings”, currently