Web app

ARN Admin Web App

The ARN Admin web app is one of the tools available for administrating an ARN Server and its hosted projects. You can access the web app at https://arn-admin.netlify.app.

Adding a Server

To connect to an existing ARN Server, follow these steps:

1. Open the ARN Admin web app.
2. Click on the "Add server" button located at the bottom right of the app.

3. A popup will appear, allowing you to enter the ARN Server URL and an API key for accessing the administration API routes. The API key can be either a project's administrator API key or a server administrator API key. Server administrators have the additional privilege of creating new projects.

💡

Once added, the server URLs and API keys you enter will be remembered.

4. If the URL and API key are correct and match, the server will appear in the list. It will display the number of projects hosted on that server.

Administrating a Server

To view the list of projects hosted by a server, click on the server name to expand its details.

To view the details of a specific project, click on the project name. It will display the project's configuration and data.

Configuration Administration

To edit a project's configuration, click on the project name to expand it. An editor will be displayed, allowing you to modify the configuration in RAW JSON format.

The "Export" and "Update" buttons are available for saving the configuration to a file (as a backup) and updating the project's configuration on the server, respectively.

Data Administration

To edit a project's data, click on the project name to expand it. A filtering form and an editable fetch result will be displayed.

To fetch data, submit a filter by entering the desired filter syntax (some/path?some.path.field=value) and hit return or click the "Fetch" button.

💡

Filters are expected to comply with the specified syntax. For example: i18n/fr/auth?i18n.fr.auth.notifContentSigError=La signature n'est pas valide.

The fetched data will appear in the raw JSON editor. You can edit the data and click either "Export" or "Update" to send a modified version to the server.

📌

• Leaving the filter empty will retrieve all available data.

• You can create new data by specifying its desired location (collection path) in the filter, entering a value, and clicking the "Update" button.

Conditions Data

ARN allows conditions to be stored in any MongoDB database, but they are usually stored in a condition collection within a project's data. You can review or

edit/update such conditions by specifying the appropriate condition filter.

For example, here is how a whitelist condition can be parameterized:

Internationalization Data

ARN allows translations to be stored in any MongoDB database, but they are typically stored in an i18n collection within a project's data. You can review or edit/update these translations by specifying the appropriate i18n filter.

Other Administration Tools

In addition to the ARN Admin web app, there are other tools available for administrating an ARN Server and its projects. These tools provide command-line interfaces (CLIs) to perform various administrative tasks.

Please refer to the previous section titled "Commands" for detailed information on using these tools and their available commands and options.

📌

The ARN Admin web app is just one of the possible tools for administrating an ARN Server and its projects. It provides a user-friendly graphical interface, while the command-line tools offer more flexibility and automation capabilities. Choose the tool that best suits your requirements and preferences.