Skip to content

Improve performance by caching Filament components and warn if APP_KEY is missing #19

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
thespad merged 8 commits into from
Jun 7, 2024
Merged

Improve performance by caching Filament components and warn if APP_KEY is missing #19

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
255cece
cache filament components
alexjustesen Jun 7, 2024
2fb2a4d
warn and no longer generate an app key
alexjustesen Jun 7, 2024
4f3e90e
added app key to a required param and updated change log
alexjustesen Jun 7, 2024
052deae
better key wording
alexjustesen Jun 7, 2024
9df787b
dont copy production env file, no longer exists
alexjustesen Jun 7, 2024
e22556d
Sleep if no app_key set. Add dummy app_key to CI
thespad Jun 7, 2024
769db0a
Add new vars to readme
thespad Jun 7, 2024
b5cd776
Consistency tweaks
thespad Jun 7, 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
Prev Previous commit
Next Next commit
Add new vars to readme
  • Loading branch information
@thespad
thespad committed Jun 7, 2024
commit 769db0ad8fab2391aac84c47ce488231fcaf9af7
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,15 @@ services:
- TZ=Etc/UTC
- APP_KEY=
- DB_CONNECTION=sqlite
- SPEEDTEST_SCHEDULE=
- SPEEDTEST_SERVERS=
- DB_HOST= #optional
- DB_PORT= #optional
- DB_DATABASE= #optional
- DB_USERNAME= #optional
- DB_PASSWORD= #optional
- DISPLAY_TIMEZONE=Etc/UTC #optional
- PRUNE_RESULTS_OLDER_THAN=0 #optional
volumes:
- /path/to/data:/config
ports:
Expand All @@ -101,11 +105,15 @@ docker run -d \
-e TZ=Etc/UTC \
-e APP_KEY= \
-e DB_CONNECTION=sqlite \
-e SPEEDTEST_SCHEDULE= \
-e SPEEDTEST_SERVERS= \
-e DB_HOST= `#optional` \
-e DB_PORT= `#optional` \
-e DB_DATABASE= `#optional` \
-e DB_USERNAME= `#optional` \
-e DB_PASSWORD= `#optional` \
-e DISPLAY_TIMEZONE=Etc/UTC `#optional` \
-e PRUNE_RESULTS_OLDER_THAN=0 `#optional` \
-p 80:80 \
-v /path/to/data:/config \
--restart unless-stopped \
Expand All @@ -124,11 +132,15 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e APP_KEY=` | App key used for encrypting stored data. You can generate a key at [https://speedtest-tracker.dev](https://speedtest-tracker.dev) |
| `-e DB_CONNECTION=sqlite` | Set the database type to use. `sqlite`, `pgsql`, or `mysql` |
| `-e SPEEDTEST_SCHEDULE=` | Set the test schedule in cron format. e.g. `0 */6 * * *` |
| `-e SPEEDTEST_SERVERS=` | A comma-separated list of server IDs to test against. Run `docker exec speedtest-tracker php /app/www/artisan app:ookla-list-servers` to get a list of nearby servers. |
| `-e DB_HOST=` | Database hostname (postgres/mysql). |
| `-e DB_PORT=` | Database port (postgres/mysql). |
| `-e DB_DATABASE=` | Database name (postgres/mysql). |
| `-e DB_USERNAME=` | Database username (postgres/mysql). |
| `-e DB_PASSWORD=` | Database password (postgres/mysql). |
| `-e DISPLAY_TIMEZONE=Etc/UTC` | Timezone for the UI. |
| `-e PRUNE_RESULTS_OLDER_THAN=0` | Days to keep test results. |
| `-v /config` | Contains speedtest-tracker config and database, if using sqlite. |

## Environment variables from files (Docker secrets)
Expand Down
4 changes: 4 additions & 0 deletions readme-vars.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ param_usage_include_env: true
param_env_vars:
- { env_var: "APP_KEY", env_value: "", desc: "App key used for encrypting stored data. You can generate a key at [https://speedtest-tracker.dev](https://speedtest-tracker.dev)" }
- { env_var: "DB_CONNECTION", env_value: "sqlite", desc: "Set the database type to use. `sqlite`, `pgsql`, or `mysql`" }
- { env_var: "SPEEDTEST_SCHEDULE", env_value: "", desc: "Set the test schedule in cron format. e.g. `0 */6 * * *`" }
- { env_var: "SPEEDTEST_SERVERS", env_value: "", desc: "A comma-separated list of server IDs to test against. Run `docker exec speedtest-tracker php /app/www/artisan app:ookla-list-servers` to get a list of nearby servers." }
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Contains speedtest-tracker config and database, if using sqlite." }
Expand All @@ -36,6 +38,8 @@ opt_param_env_vars:
- { env_var: "DB_DATABASE", env_value: "", desc: "Database name (postgres/mysql)." }
- { env_var: "DB_USERNAME", env_value: "", desc: "Database username (postgres/mysql)." }
- { env_var: "DB_PASSWORD", env_value: "", desc: "Database password (postgres/mysql)." }
- { env_var: "DISPLAY_TIMEZONE", env_value: "Etc/UTC", desc: "Timezone for the UI." }
- { env_var: "PRUNE_RESULTS_OLDER_THAN", env_value: "0", desc: "Days to keep test results." }

# application setup block
app_setup_block_enabled: true
Expand Down