Skip to content

Update env #168

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 18, 2024
Merged

Update env #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68aa89f
Update env
hermesdj Jan 22, 2024
7b6135a
Update .gitignore
Crypta-Eve Apr 18, 2024
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
venv/
site/
site/
51 changes: 29 additions & 22 deletions docs/configuration/env_file_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,35 @@

# Env Reference

In both the case of a Docker installation as well as a host based installation (manual or via SeAT tool), SeAT has some configuration values that can be set via an `.env` file. Depending on your installation type, this file will be in either `/opt/seat-docker/.env` or in `/var/www/seat/.env`
In both the case of a Docker installation as well as a host based installation (manual or via SeAT tool), SeAT has some
configuration values that can be set via an `.env` file. Depending on your installation type, this file will be in
either `/opt/seat-docker/.env` or in `/var/www/seat/.env`

## Configuration Value Reference

| Parameter Name | Default value | Description |
|-------------------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| APP_URL | http://seat.local | This is the public address where SeAT instance is reachable. That should match with the `EVE_CALLBACK_URL` without `/auth/eve/callback` suffix |
| DB_HOST | 127.0.0.1 | This is the IP or domain from your SQL Server. |
| DB_PORT | 3306 | This is the port used by your SQL Server to receive query. |
| DB_DATABASE | seat | This is the name for your SeAT database. |
| DB_USERNAME | seat | This is the user which is granted to the SeAT database from SeAT server. |
| DB_PASSWORD | secret | This is the user password |
| MAIL_DRIVER | smtp | This is the driver used to send mail. It will be covered in a dedicated article. |
| MAIL_HOST | smtp.mailtrap.io | This is driver mail hostname. It will be covered in a dedicated article. |
| MAIL_PORT | 2525 | This is the driver mail port. It will be covered in a dedicated article. |
| MAIL_USERNAME | null | This is the driver mail username. It will be covered in a dedicated article. |
| MAIL_PASSWORD | null | This is the driver mail password. It will be covered in a dedicated article. |
| MAIL_ENCRYPTION | null | This is the driver mail encryption. It will be covered in a dedicated article. |
| MAIL_FROM_ADDRESS | noreply@localhost.local | This is the mail address which the user will chown when he will receive mail from SeAT. |
| MAIL_FROM_NAME | SeAT Administrator | This is the name which the user will chown when he will receive mail from SeAT. |
| EVE_CLIENT_ID | null | This is the EVE Application Client ID you'll get when you created an application over https://developers.eveonline.com |
| EVE_CLIENT_SECRET | null | This is the EVE Application Client Secret you'll get when you created an application over https://developers.eveonline.com |
| EVE_CALLBACK_URL | https://seat.local/auth/eve/callback | This is the EVE Application Callback URL you filled when you created an application over https://developers.eveonline.com. You should have only to fix `seat.local` |
| QUEUE_BALANCING_MODE | false | Determine the workers balancing mode used by the Jobs Manager. Value can be `false`, `auto` or `simple`. See [official Laravel documentation](https://laravel.com/docs/5.8/horizon#balance-options) for more details |
| QUEUE_WORKERS | 4 | Determine the amount of worker which have to be spawn to process jobs over all queues. In `auto` and `simple` balancing, this value cannot be lower than `4` as it's correspond to the available queues. |
| Parameter Name | Default value | Description |
|-----------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| APP_URL | http://seat.local | This is the public address where SeAT instance is reachable. That should match with the `EVE_CALLBACK_URL` without `/auth/eve/callback` suffix |
| APP_LOCALE | en | This is the locale used by the server to generate translated strings. |
| DB_HOST | 127.0.0.1 | This is the IP or domain from your SQL Server. |
| DB_PORT | 3306 | This is the port used by your SQL Server to receive query. |
| DB_DATABASE | seat | This is the name for your SeAT database. |
| DB_USERNAME | seat | This is the user which is granted to the SeAT database from SeAT server. |
| DB_PASSWORD | secret | This is the user password |
| MAIL_DRIVER | smtp | This is the driver used to send mail. It will be covered in a dedicated article. |
| MAIL_HOST | smtp.mailtrap.io | This is driver mail hostname. It will be covered in a dedicated article. |
| MAIL_PORT | 2525 | This is the driver mail port. It will be covered in a dedicated article. |
| MAIL_USERNAME | null | This is the driver mail username. It will be covered in a dedicated article. |
| MAIL_PASSWORD | null | This is the driver mail password. It will be covered in a dedicated article. |
| MAIL_ENCRYPTION | null | This is the driver mail encryption. It will be covered in a dedicated article. |
| MAIL_FROM_ADDRESS | noreply@localhost.local | This is the mail address which the user will chown when he will receive mail from SeAT. |
| MAIL_FROM_NAME | SeAT Administrator | This is the name which the user will chown when he will receive mail from SeAT. |
| EVE_CLIENT_ID | null | This is the EVE Application Client ID you'll get when you created an application over https://developers.eveonline.com |
| EVE_CLIENT_SECRET | null | This is the EVE Application Client Secret you'll get when you created an application over https://developers.eveonline.com |
| EVE_CALLBACK_URL | https://seat.local/auth/eve/callback | This is the EVE Application Callback URL you filled when you created an application over https://developers.eveonline.com. You should have only to fix `seat.local` |
| QUEUE_BALANCING_MODE | false | Determine the workers balancing mode used by the Jobs Manager. Value can be `false`, `auto` or `simple`. See [official Laravel documentation](https://laravel.com/docs/5.8/horizon#balance-options) for more details |
| QUEUE_WORKERS | 4 | Determine the amount of worker which have to be spawn to process jobs over all queues. In `auto` and `simple` balancing, this value cannot be lower than `4` as it's correspond to the available queues. |
| ESEYE_CACHE_DRIVER | file | Determine the driver used to cache eseye data. available values are file, redis |
| ESEYE_CACHE_STORAGE_PATH | eseye | When using the file driver, this is the name of the folder in seat/storage that will store the cache files |
| ESEYE_CACHE_CONNECTION | cache | When using the redis driver, this is the name of the redis connection. If using 'cache', it will reuse the existing redis cache configuration found in seat/config/cache.php. It must be a configured connection |
| ESEYE_CACHE_LOCK_CONNECTION | default | When using the Redis driver, it will be the connection used to lock the cache |
12 changes: 12 additions & 0 deletions docs/installation/docker_installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,18 @@ Next, decompress the template archive:
Expand-Archive -Path c:\seat-docker\seat-docker.zip -DestinationPath c:\seat-docker
```

Next, we will rename the file .env.example to .env in the root directory of seat-docker

=== "Linux"
```bash
mv /opt/seat-docker/.env.example /opt/seat-docker/.env
```

=== "Windows"
```powershell
Rename-Item -Path "c:\seat-docker\.env.example" -NewName ".env"
```

Next, we will generate a unique application key - this is used internally for encryption:

=== "Linux"
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrading/from_seat_4_0/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ We highly recommend that you read the details of this upgrade guide to get famil
```
- Download the new `.env` file template using
```bash
curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/.env -o .env
curl -L https://raw.githubusercontent.com/eveseat/seat-docker/master/.env.example -o .env
```
- Update the new `.env` file using your backup `.env.seat4.bak`

Expand Down