Git Product home page Git Product logo

ispconfig-acmesh's Introduction

ISPConfig-AcmeSH

This project is just a simple script to simplify installing new Acme.SH certificates into ISPconfig using their SoapServer.

Installation and setup

Requirements:

  • php7+ with soap and openssl module enabled
  • git (preffered), curl or wget ( to download the project )
  • acme.sh
  • ISPConfig
  • Any code editor you are comfortable with

Installation

  1. Git clone or download the project onto your server ( git clone https://github.com/Aperture-Development/ISPConfig-AcmeSH.git <output path> )
  2. Open the acmesh_ispconfig.php file and edit the top part with your environment data ( look below to see how to setup ISPConfig )
  3. Save and close the file

ISPConfig setup

  1. Log into ISPConfig
  2. Select "System" > "Remote Users" and "Add new user"
  3. Create a new remote user with the permissions "Server functions", "Sites Domain functions", "Sites Aliasdomain functions", "Sites Subdomain functions" and "Client functions"

If you do not want to specify your ISPConfig username or password inside the file, you can use the --username and --password parameters to use temporary environment variables.

Usage

Basic Usage:

acmesh_ispconfig.php -d <domain> [-d <domain>...]

Advanced Parameters:

Usage: acmesh_ispconfig.php [OPTIONS]

Options:
 -d, --domain DOMAIN     pass DOMAIN to be updated ( required )
 -h, --help              display this help message and exit ( optional )
 -s, --service           provide services to be reloaded after the certificate has been updated ( optional )
 -u, --username          the ISPConfig API username ( optional )
 -p, --password          the ISPConfig API password ( optional )
 -l, --uri               the ISPConfig remote URI ( optional )
 -r, --reloadcmd         the reload cmd to be used to restart services ( optional )

Automatically run the script after renewing a certificate: When you issue the certificate you need to provide the --renew-hook parameter to run the php script after your certificate has been sucessfully renewed.
Example parameter: acme.sh --issue -d example.com --renew-hook "/path/to/script/acmesh_ispconfig.php -d example.com -s dovecot -s postfix"

More informations can be found here: https://github.com/acmesh-official/acme.sh/wiki/Using-pre-hook-post-hook-renew-hook-reloadcmd

Licence and Info

This project has been developed by Aperture Development and is licenced under by-sa 4.0.
You can find more informations about the licence terms inside the LICENSE file

ispconfig-acmesh's People

Contributors

aperturedevelopment avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.