Skip to content

Commit

Permalink
Add docker support section + tip
Browse files Browse the repository at this point in the history
  • Loading branch information
billz committed Mar 14, 2024
1 parent a06b752 commit c9625c7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/restapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ RaspAP Install: Configure RestAPI
Install and enable RestAPI? [Y/n]:
```

!!! tip "Tip"
The RestAPI is enabled by default in RaspAP's [Docker container](restapi.md#docker-support), so if you choose this option there is nothing more for you to do.

The Python language is a requirement for the RestAPI. The Quick installer will detect if Python is not installed on your system and install it for you (Python 3 is installed by default on Raspberry Pi OS). In addition, Python's package manager `pip` will also be installed. The following Python packages are requirements for the RestAPI:

```
Expand Down Expand Up @@ -137,6 +140,9 @@ WantedBy=multi-user.target

Save and exit the file, then reload the daemon with `sudo systemctl daemon-reload`.

## Docker support
The RestAPI is installed by default in RaspAP's [Docker container](docker.md). This includes configuration of port `8081` used by the server to respond to client requests. Note that the API is also exposed on your system's WAN interface.

## Troubleshooting
The current status of the `restapi.service` is available on the **RestAPI > Status** tab. This is generally the best starting point when diagnosing common problems, such as authorization errors. Note that the service records the most recent API queries, including the requesting IPv4 client address:

Expand Down

0 comments on commit c9625c7

Please sign in to comment.