Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak set up instructions #104

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,37 @@ 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 `
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm docker compose commands, when we have:
https://github.com/joomlatools/joomlatools-server/blob/master/bin/jtctl

Establish how to provide profile arguments into this command and remove references to docker compose

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sh bin/jtctl start

Actually loads up all available profiles:
https://github.com/joomlatools/joomlatools-server/blob/master/bin/jtctl#L183

So this issue/ Pull request is not needed


For further information about docker compose profiles:

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

PS. don't forget to stop these services when you have finished

`docker compose --profile [mailhog | all]`

## 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