Update confusing steps and remove outdated info at README

This commit is contained in:
2025-03-04 15:58:04 +01:00
parent d1d1c2f0d2
commit 3fc314a38b
+7 -8
View File
@@ -21,6 +21,8 @@ docker compose up -d --build
#### 2.1 Configuring the containers.
The following steps are optional, unless you need to specify ports or configure the default Docker build in some way you can skip to step *2.2. Post build setup.*
To avoid ownership issues for files generated inside the PHP container the default Compose config will try to export your user's and group's ID, or **1000** if it can't find them, to the user inside the container. If that is not your ID you can pass your actual IDs using the env vars `UID` and `GID`.
In a similar fashion you can override the nginx container binding to the ports **:8090** (for http) and **:8091** (for https) on your host with the env vars `APP_HTTP_PORT` and `APP_HTTPS_PORT`.
@@ -59,27 +61,24 @@ docker compose up -d --build
After the Docker containers are first built, you'll need to finish the PHP setup.
```shell
# Install composer.json dependencies
bin/docker php composer install
php composer install
# Create the database
# May throw an error if the DB already exists, no further action required if so
bin/docker php bin/console doctrine:database:create
php bin/console doctrine:database:create
# Update the database schema
# Might be changed to use doctrine migrations in the future
bin/docker php bin/console doctrine:schema:update --force
# Setup Gateway services
bin/docker php bin/console app:gateways:setup
php bin/console doctrine:schema:update --force
```
## Usage
The app should be live at [http://localhost:8090](http://localhost:8090) (or your specified ports). Keep in mind that the API address is [/v4](http://localhost:8090/v4).
You can access a real-time build of the OpenAPI spec file for v4 at [http://localhost:8090/v4/docs.json](http://localhost:8090/v4/docs.json), to be used, for example, with API development suites such as Hoppscotch. This file will be up to date with most of your latest changes.
You can access a real-time build of the OpenAPI spec file for v4 at [/v4/docs.json](http://localhost:8090/v4/docs.json), to be used, for example, with API development suites such as Postman. This file will be up to date with most of your latest changes.
A Swagger UI version of the docs is also available at [http://localhost:8090/v4/docs?ui=swagger_ui](http://localhost:8090/v4/docs?ui=swagger_ui).
The API also builds a small ReDoc frontend to act as documentation at [/v4/docs](http://localhost:8090/v4/docs). A Swagger UI version of the docs is also available at [/v4/docs?ui=swagger_ui](http://localhost:8090/v4/docs?ui=swagger_ui).
For quick Docker access you can use the `bin/docker` shortcut to quickly `exec` anything into one of the containers. It expects the name of the Docker Compose service as first parameter, then you can pass whatever it is that you wish to exec into that container, e.g: