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

Update documentation to include the headless option #110

Merged
merged 1 commit into from
Oct 26, 2024

Conversation

jlucaspains
Copy link
Owner

@jlucaspains jlucaspains commented Oct 26, 2024

Update the readme.md to include information about the HEADLESS environment variable and its usage.

  • Add a new section for the HEADLESS environment variable.
  • Explain that setting HEADLESS to "true" will prevent the web server from starting.
  • Explain that setting HEADLESS to "true" and CHECK_CERT_JOB_SCHEDULE to an empty value will run the job task only once and exit with a success code.
  • Remove the Issue and renew certs item and its children from the Features section.
  • Add a code section under the new Headless Mode section to demonstrate running the app as an Azure ContainerApp job using AZ CLI.
    • Include the HEADLESS environment variable in the command.
    • Include a schedule to run the job every Monday at 8 AM.
    • Specify CPU as 0.25 and memory as 0.5Gi.
    • Include an environment variable for an example site like other examples in the readme file.

For more details, open the Copilot Workspace session.

Update the `readme.md` to include information about the `HEADLESS` environment variable and its usage.

* Add a new section for the `HEADLESS` environment variable.
* Explain that setting `HEADLESS` to "true" will prevent the web server from starting.
* Explain that setting `HEADLESS` to "true" and `CHECK_CERT_JOB_SCHEDULE` to an empty value will run the job task only once and exit with a success code.
* Remove the `Issue and renew certs` item and its children from the `Features` section.
* Add a code section under the new Headless Mode section to demonstrate running the app as an Azure ContainerApp job using AZ CLI.
  * Include the `HEADLESS` environment variable in the command.
  * Include a schedule to run the job every Monday at 8 AM.
  * Specify CPU as 0.25 and memory as 0.5Gi.
  * Include an environment variable for an example site like other examples in the readme file.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/jlucaspains/sharp-cert-manager?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link

ok github.com/jlucaspains/sharp-cert-manager 0.005s coverage: 19.0% of statements
? github.com/jlucaspains/sharp-cert-manager/models [no test files]
github.com/jlucaspains/sharp-cert-manager/midlewares coverage: 0.0% of statements
ok github.com/jlucaspains/sharp-cert-manager/handlers 0.408s coverage: 93.6% of statements
ok github.com/jlucaspains/sharp-cert-manager/jobs 0.789s coverage: 93.1% of statements
ok github.com/jlucaspains/sharp-cert-manager/shared 10.178s coverage: 90.7% of statements

Copy link

sonarcloud bot commented Oct 26, 2024

@jlucaspains jlucaspains merged commit 97e7c71 into main Oct 26, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant