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

Provide basic documentation about the script #10

Open
bluepuma77 opened this issue Oct 19, 2024 · 1 comment
Open

Provide basic documentation about the script #10

bluepuma77 opened this issue Oct 19, 2024 · 1 comment

Comments

@bluepuma77
Copy link

You want us to (blindly) execute a shell script, it would be great to provide some basic info in the README:

  1. Where is the script installed?
  2. What for and how is the email used?
  3. Why a cron job is installed and what is it doing?

I just want to create certs with a DNS provider. Probably I can set email with other credentials and don't need any cron job.

@user8446
Copy link

user8446 commented Dec 6, 2024

The install is actually in acme.sh, all this does is download it and enter your email address.

AI definition:

  1. It defines a function _exists that checks if a given command is available on the system.

  2. It sets the BRANCH variable to "master" if it's not already defined.

  3. It extracts the _email parameter from the command-line arguments, which is expected to be in the format "email=[email protected]".

  4. It constructs the URL "https://raw.githubusercontent.com/acmesh-official/acme.sh/$BRANCH/acme.sh" to download the acme.sh script.

  5. It determines the appropriate method to download the script, either using curl or wget, and stores the command in the _get variable.

  6. Finally, it downloads the acme.sh script and runs it with the --install-online option, passing the _email parameter and any additional arguments.

If the installation fails, the script prints an error message and provides a link to the installation instructions for users in China.

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

No branches or pull requests

2 participants