diff options
| author | Ben Busby <contact@benbusby.com> | 2023-07-17 17:46:39 -0600 |
|---|---|---|
| committer | Ben Busby <contact@benbusby.com> | 2023-07-17 17:46:39 -0600 |
| commit | 7693a6b0633c3eee5d717662df72b62463d6f2d1 (patch) | |
| tree | 66507a2bf09db6a72381203de3088198538d1d92 /README.md | |
| parent | 9104650cfecfb7f6aea42fc755b565f19c79d370 (diff) | |
| download | farside-7693a6b0633c3eee5d717662df72b62463d6f2d1.tar.gz | |
Add env var for toggling cron task on/off
FARSIDE_CRON allows turning on/off the scheduled instance availability
check that occurs every 5 minutes by setting the variable to 1 (on) or 0
(off). The default behavior is "on".
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -193,7 +193,7 @@ goes against what Farside is trying to solve. Use at your own discretion. To run Farside without compiling, you can perform the following steps: - Install dependencies: `mix deps.get` -- Initialize db contents: `mix run -e Farside.Instances.sync` +- Initialize db contents: `FARSIDE_CRON=0 mix run -e Farside.Instances.sync` - Run Farside: `mix run --no-halt` - Uses localhost:4001 @@ -233,7 +233,11 @@ farside </tr> <tr> <td>FARSIDE_SERVICES_JSON</td> - <td>The "services" JSON file to use for selecting instances (default: `services.json`)</td> + <td>The JSON file to use for selecting instances (default: `services.json`)</td> + </tr> + <tr> + <td>FARSIDE_CRON</td> + <td>Set to 0 to deactivate the scheduled instance availability check (default on).</td> </tr> </table> |