Skip to content

Commit

Permalink
#103: suggested changes to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yiendos committed Jul 15, 2023
1 parent 1f7de77 commit 2e0e413
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,33 @@ The server provides following default HTTP(s) endpoints
- http://localhost:8080/__info/php-opcache
- http://localhost:8080/__info/php-xdebug (only if xdebug is enabled)

## Optional services

In order to provide you with a minimal, fast local environment; we've opted to not initialise the joomlatools-server with the following options:

* Dnsmasq
* Traefix
* Minica
* Phpmyadmin
* Mailhog
* Dozzle

In order to run any of these services, at start up, all you need to do is provide the profile option during the compose up:

`docker compose --profile mailhog up -d`

For instance, this will start the Mailhog service, which will let you intercept emails sent from your application in a handy to use graphical interface available at: http://localhost:8380/

The [docker-compose.yml](https://github.com/joomlatools/joomlatools-server/blob/master/docker-compose.yml#L192) file is documented as to how to start and control each of these additional profiles.

If you wanted to run all of these services at once:

`docker compose --profile all up -d `

For further information about docker compose profiles:

[https://docs.docker.com/compose/profiles/](https://docs.docker.com/compose/profiles/)

## Documentation

You can find all the documentation for Joomlatools Server [in the wiki](https://github.com/joomlatools/joomlatools-server/wiki). Happy coding!
Expand Down
2 changes: 1 addition & 1 deletion bin/jtctl
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ else
display_help
fi

# Source the ".env" file so Laravel's environment variables are available...
# Source the ".env" if it is available
if [ -f ./.env ]; then
source ./.env
fi
Expand Down

0 comments on commit 2e0e413

Please sign in to comment.