KeexyBox's wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== KeexyBox - Manage users ======

For KeexyBox, a user is a person who can enter a login and password on the device he uses to connect it to the Internet. An Internet browser must be at least available on the device.
A user can use the same credentials to connect multiples devices to the Internet. If you do not want to have entering a login and password to connect a device to the Internet go to this topic: [[devices_manage|Manage devices]]. Or since version **21.04.1**, it is possible to disable the [[system_settings_captiveportal|captive portal]] to prevent users from authenticating to access the Internet. 

To manage users:

  - Use your browser and connect to the [[using_admin_access|KeexyBox Management Web interface]].
  - On left menu, go to ''Connection settings -> Users''.
  - You will be redirected to the ''Users'' page.


===== Add a user =====

  - Click on {{:keexybox_ico:plus.png?nolink}} at the top of ''Users'' page.
  - [[#Edit a user|Edit the user settings]].
  - Click on ''Save''.

===== Modify a user =====

  - On the ''Users'' page, identify in the list the user you wish to edit.
  - Click on ''Edit'' {{:keexybox_ico:edit.png?nolink}} button. 
  - [[#Edit a user|Edit the user settings]].
  - Click on ''Save''.

===== Edit a user =====
^Field^Description^
|**Display name**|The user name to display.|
|**Email**|The user Email address (optional).|
|**Login**|Login to connect to the Internet.|
|**Password**|Login password (leave it blank if you do not want to change it in case of modification)|
|**Confirm password**|Confirmation of login password (leave it blank if you do not want to change it)|
|**Profile**|Set the connection [[profiles_manage|profile]].|
|**Language**|Select the language of the user.|
|**Expiration**|Define an expiration date for the account (Leave blank for no expiration).|
|**Enable**|Check this box to enable the user otherwise uncheck it.|
|**Admin**|Check this box if you want to grant privileges to user to manage KeexyBox.|

===== Delete a user =====

  - On the ''Users'' page, identify in the list the user you wish to delete.
  - Click on ''delete'' {{:keexybox_ico:trash.png?nolink}} button.
  - You will get a message asking you to confirm the deletion. Answer ''yes''.

Connected user will be disconnected and then deleted.

:!: Note that the default administrator account of KeexyBox cannot be deleted.

===== Export/Import users =====

KeexyBox allows you to export or import users from CSV files.

Exporting or Importing users can be useful in the following cases:
  * To backup the list of KeexyBox users.
  * To massively create users.
  * To make massive changes to users.
  * To import users to another KeexyBox.

=== Export users to CSV file ===

  - Click on {{:keexybox_ico:export.png?nolink}} at the top of ''Users'' page.
  - Save the file wherever you want on your device.

=== Import users from CSV file ===

You must first prepare a CSV file containing the list of users. We recommend that you export the list of KeexyBox's users in order to have a template for creating the import file.

The fields of the CSV file are described below.

^Field^Description^
|**username**|Login for the Internet connection. If a login has the same name in KeexyBox, all settings will be overwritten with the values from the CSV file.|
|**displayname**|Username name to display.|
|**password**|The password can be encrypted or in clear. If the length is less than 60, the password defined will be considered as clear and if it is equal to 60 as encrypted.|
|**profilename**|The name of the profile. If the profile does not exist on KeexyBox, the user will be set to the default profile.|
|**lang**|The language displayed on KeexyBox Web interface for the user. If the language is unknown by KeexyBox the default KeexyBox langage will be set.|
|**enabled**|''1'' to enable the user, ''0'' or empty to disable the user.|
|**admin**|''1'' to set the user as admin otherwise ''0'' or empty.|

:!: Do not change the position of the fields.

When your file is ready: 

  - Click on {{:keexybox_ico:import.png?nolink}} at the top of ''Users'' page.
  - On ''Select csv file'' click on ''Browse''.
  - Select the CSV file to import.
  - Click on ''Save''.

===== Bulk action on users =====

Bulk actions allows you to massively doing actions on users. On the ''Users'' page:

  - Check boxes to the left of listed users.
  - At the bottom of the page, on the selection menu ''(select action)'', choose one of the available actions.
  - Click on ''Run'' to confirm the action.

The available actions are discribed below:
  * ''Disable'': This action allows you to disable selected users.
  * ''Enable'': This action allows you to enable selected users.
  * ''Change the profile'': This action allows change the profile of selected users.
  * ''Delete'': This action allows you to delete selected users.