Skip to content

Commit

Permalink
changes to the README file
Browse files Browse the repository at this point in the history
minor tweaks to code and layout
  • Loading branch information
malle-pietje committed Jan 5, 2020
1 parent a2358c0 commit 4aceffc
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 13 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,14 @@ Please keep the following in mind:
- please read the Security Notice below before installing this tool!


### Demo ###

A demo version that is connected to Ubiquiti's demo controller is available here: https://api-browser-demo.artofwifi.net/


### Upgrading from 1.X to 2.X

Because the structure of the configuration file has changed slightly, we recommend creating a fresh install when upgrading from 1.X to 2.X.
Because the structure of the configuration file has changed, we recommend creating a fresh install when upgrading from 1.X to 2.X.


### Features
Expand Down Expand Up @@ -117,7 +122,7 @@ Alternatively you may choose to download the zip file and unzip it in your direc

### Configuration

- credentials for access to the UniFi Controller API can be configured, in part or in whole, in the file named `config/config-template.php` which should be copied/renamed to `config/config.php`
- credentials for access to the UniFi Controller API are configured in the file named `config/config-template.php` which should be copied/renamed to `config/config.php`
- starting with version 1.0.3, you can store **multiple controller configurations** in an array inside the `config/config.php` file
- please refer to the instructions in the `config/config-template.php` file for further configuration instructions
- starting with API browser tool version 2.0.0 you can restrict access to the tool by creating user accounts and passwords, please refer to the instructions in the `config/users-template.php` file for further details
Expand Down
2 changes: 1 addition & 1 deletion common.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* with this package in the file LICENSE.md
*
*/
define('TOOL_VERSION', '2.0.5');
define('TOOL_VERSION', '2.0.6');

/**
* gather some basic information for the About modal
Expand Down
2 changes: 1 addition & 1 deletion config/users-template.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
*
* IMPORTANT NOTE:
* If you do not create the users.php file or do no create any user accounts, the API browser tool
* will be accessible without providing and means of authentication.
* will be accessible without providing any means of authentication.
*/
$users = [
[
Expand Down
3 changes: 2 additions & 1 deletion templates/collections_view.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
<input class="" type="radio" name="options" id="output_kint" value="kint" autocomplete="off"> PHP array, interactive
</label>
<label class="btn btn-secondary btn-sm output_radio_button">
<input class="" type="radio" name="options" id="output_kint_plain" value="kint_plain" autocomplete="off"> PHP array, hightlighted
<input class="" type="radio" name="options" id="output_kint_plain" value="kint_plain" autocomplete="off"> PHP array, highlighted
</label>
</div>
</div>
Expand All @@ -90,6 +90,7 @@
</div>
</div>
</div>

<br>
<br>
{% endblock %}
Expand Down
12 changes: 4 additions & 8 deletions templates/config_error.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,11 @@
<div class="container h-100">
<div class="row align-items-center h-100">
<div class="col-sm-6 mx-auto">
<div class="card text-center shadow-sm">
<div class="card-body">
<br>
<div class="alert alert-danger" role="alert">
{{error_message | raw}}
</div>
<br>
</div>
<br>
<div class="alert alert-danger shadow-sm" role="alert">
<i class="fas fa-exclamation-circle fa-lg fa-fw"></i> {{error_message | raw}}
</div>
<br>
</div>
</div>
</div>
Expand Down

0 comments on commit 4aceffc

Please sign in to comment.