diff --git a/docs/configuration/esi_configuration.md b/docs/configuration/esi_configuration.md index d6921bc..f332059 100644 --- a/docs/configuration/esi_configuration.md +++ b/docs/configuration/esi_configuration.md @@ -57,10 +57,26 @@ EVE_CLIENT_SECRET=null EVE_CALLBACK_URL=http://seat.test/auth/eve/callback ``` -!!! warning "Docker Installations" - Your `.env` file is located in `/opt/seat-docker`. Rebuild your app after setting the ESI Details in it using: - - `docker-compose up -d` +### Notes for Docker Users +Your `.env` file is located in `/opt/seat-docker`. Rebuild your app after setting the ESI Details in it using: + +=== "Docker (SeAT 4.x)" + ```bash linenums="1" + docker-compose down + docker-compose up -d + ``` + +=== "Docker (SeAT 5.x - using Traefik)" + ```bash linenums="1" + docker-compose down + docker-compose -f docker-compose.yml -f docker-compose.mariadb.yml -f docker-compose.traefik.yml -d up + ``` + +=== "Docker (SeAT 5.x - using proxy)" + ```bash linenums="1" + docker-compose down + docker-compose -f docker-compose.yml -f docker-compose.mariadb.yml -f docker-compose.proxy.yml -d up + ``` [EVE Online Developers portal]: https://developers.eveonline.com/applications [file]: https://github.com/eveseat/seat/blob/b067bd3e742a79c35b5fa44ff77380a9187a27cf/.env.example#L21-L23 diff --git a/docs/developer_guides/notifications_implementation.md b/docs/developer_guides/notifications_implementation.md index 81c10b6..c04d0cc 100644 --- a/docs/developer_guides/notifications_implementation.md +++ b/docs/developer_guides/notifications_implementation.md @@ -13,7 +13,7 @@ It is supporting e-mail, Slack and Discord out of the box. However, thanks to Laravel, if you need to support another platform - you simply need to implement the related driver. See official [Laravel Notification Channels](https://laravel-notification-channels.com) website to get more about this. -Additionally, there is a system to mention certain users when a notification gets sent. Since we don't assume that many people need to implement this for a new platform, there is no written documentation. This is a good starting point to read the code: [Config/notifications.mentions.php](https://github.com/eveseat/notifications/blob/5.0.x/src/Config/notifications.mentions.php) +Additionally, there is a system to mention certain users when a notification gets sent. Since we don't assume that many people need to implement this for a new platform, there is no written documentation. This is a good starting point to read the code: [Config/notifications.mentions.php](https://github.com/eveseat/notifications/blob/master/src/Config/notifications.mentions.php) ## Configuration diff --git a/docs/upgrading/from_seat_4_0/bare_metal.md b/docs/upgrading/from_seat_4_0/bare_metal.md index 37e4094..2009cac 100644 --- a/docs/upgrading/from_seat_4_0/bare_metal.md +++ b/docs/upgrading/from_seat_4_0/bare_metal.md @@ -96,7 +96,7 @@ systemctl restart nginx.service Once packages have been updated, we will deploy the new SeAT's version using composer. ```bash linenums="1" -composer create-project eveseat/seat /var/www/seat "5.0.x-dev" --no-dev --no-interaction +composer create-project eveseat/seat /var/www/seat "5.0" --no-dev --no-interaction ``` Once the download is done, you should have seen output such as: diff --git a/docs/upgrading/from_seat_4_0/docker.md b/docs/upgrading/from_seat_4_0/docker.md index bc63ae9..7a27f57 100644 --- a/docs/upgrading/from_seat_4_0/docker.md +++ b/docs/upgrading/from_seat_4_0/docker.md @@ -34,14 +34,38 @@ This guide is going to step through some quick preparation steps, then perform t We highly recommend that you read the details of this upgrade guide to get familiar with what has changed. But, if this is your nth upgrade, maybe you just want to get the summary of everything, so here it is: - Make a [backup] of your database. -- `cd` to your install dir (which is probably `/opt/seat-docker`) and bring the stack down with `docker compose down` -- Make a copy of your `.env` file using `cp .env .env.seat4.bak` -- Make a copy of your current compose file using `cp docker-compose.yml docker-compose.yml.seat4.bak` -- Download the new `docker-compose.yml` file with `curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.yml -o docker-compose.yml`. -- Download the new database override `docker-compose.mariadb.yml` file with `curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.mariadb.yml -o docker-compose.mariadb.yml`. -- Download the new traefik override `docker-compose.traefik.yml` file with `curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.mariadb.yml -o docker-compose.traefik.yml`. -- Download the new proxy override `docker-compose.proxy.yml` file with `curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.mariadb.yml -o docker-compose.proxy.yml`. -- Download the new `.env` file template using `curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/.env -o .env`. +- `cd` to your install dir (which is probably `/opt/seat-docker`) and bring the stack down with + ```bash + docker compose down + ``` +- Make a copy of your `.env` file using + ```bash + cp .env .env.seat4.bak + ``` +- Make a copy of your current compose file using + ```bash + cp docker-compose.yml docker-compose.yml.seat4.bak + ``` +- Download the new `docker-compose.yml` file with + ```bash + curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.yml -o docker-compose.yml` + ``` +- Download the new database override `docker-compose.mariadb.yml` file with + ```bash + curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.mariadb.yml -o docker-compose.mariadb.yml + ``` +- Download the new traefik override `docker-compose.traefik.yml` file with + ```bash + curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.mariadb.yml -o docker-compose.traefik.yml + ``` +- Download the new proxy override `docker-compose.proxy.yml` file with + ```bash + curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.mariadb.yml -o docker-compose.proxy.yml + ``` +- Download the new `.env` file template using + ```bash + curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/.env -o .env + ``` - Update the new `.env` file using your backup `.env.seat4.bak` The table bellow is provided as a variable mapping between SeAT 4.x and SeAT 5.x. You can use it as a reference. @@ -173,16 +197,17 @@ Removing network seat-docker_seat-network #### Get the new docker-compose files !!! warning - If you have made customisations to how you deployed SeAT with docker-compose, then you should probably **not** be replacing the compose file like we are about to do. Instead, have a look at the new one [here](https://github.com/eveseat/seat-docker/blob/5.0.x/docker-compose.yml) and adapt. + If you have made customisations to how you deployed SeAT with docker-compose, then you should probably **not** +be replacing the compose file like we are about to do. Instead, have a look at the new one [here](https://github.com/eveseat/seat-docker/blob/master/docker-compose.yml) and adapt. Next, we will download the new SeAT 5 docker-compose files. Do that with: ``` bash linenums="1" mv docker-compose.yml docker-compose.yml.seat4.bak -curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.yml -o docker-compose.yml -curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.mariadb.yml -o docker-compose.mariadb.yml -curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.traefik.yml -o docker-compose.traefik.yml -curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/docker-compose.proxy.yml -o docker-compose.proxy.yml +curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.yml -o docker-compose.yml +curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.mariadb.yml -o docker-compose.mariadb.yml +curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.traefik.yml -o docker-compose.traefik.yml +curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/docker-compose.proxy.yml -o docker-compose.proxy.yml ``` With this we have created a copy of the older docker-compose file (just in case), and downloaded the new one. @@ -195,10 +220,10 @@ some of them have been removed, newest appeared and overall have been reordered. ```bash linenums="1" mv .env .env.seat4.bak -curl -L https://raw.githubusercontent.com/eveseat/seat-docker/5.0.x/.env -o .env.yml +curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/.env -o .env.yml ``` -You can refer at any time to the online version of `.env` file on [GitHub](https://github.com/eveseat/seat-docker/blob/5.0.x/.env) +You can refer at any time to the online version of `.env` file on [GitHub](https://github.com/eveseat/seat-docker/blob/master/.env) The table bellow is provided as a variable mapping between SeAT 4.x and SeAT 5.x. You can use it as a reference. | SeAT 4.x | SeAT 5.x |