You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-6Lines changed: 23 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,18 @@
1
-
# deploy-freenas
1
+
# deploy-freenas.sh
2
2
3
-
deploy-freenas.py is a Python script to deploy TLS certificates to a FreeNAS server using the FreeNAS API. This should ensure that the certificate data is properly stored in the configuration database, and that all appropriate services use this certificate. It's intended to be called from a Let's Encrypt client like [acme.sh](https://github.com/Neilpang/acme.sh) after the certificate is issued, so that the entire process of issuance (or renewal) and deployment can be automated.
3
+
deploy-freenas.sh is a shell script to deploy TLS certificates to a FreeNAS server using the FreeNAS API. This should ensure that the certificate data is properly stored in the configuration database, and that all appropriate services use this certificate. It's intended to be called from a Let's Encrypt client like [acme.sh](https://github.com/Neilpang/acme.sh) after the certificate is issued, so that the entire process of issuance (or renewal) and deployment can be automated.
4
+
5
+
This project was remade from project deploy-freenas.py by danb35 due to the impossibility of using Python in the closed structure of the OPNsense system.
4
6
5
7
# Installation
6
-
This script can run on any machine running Python 3 that has network access to your FreeNAS server, but in most cases it's best to run it directly on the FreeNAS box. Change to a convenient directory and run `git clone https://github.com/danb35/deploy-freenas`.
8
+
This script can run on any machine running Bourne shell (all *nix systems, macOS; for Windows you need to install additional package, like [CygWin](https://www.cygwin.com/)) that has network access to your FreeNAS server, but in most cases it's best to run it directly on the FreeNAS box. Change to a convenient directory and run `git clone https://github.com/Limych/deploy-freenas`
7
9
8
10
# Usage
9
11
12
+
There are now two ways to usage of this script:
13
+
14
+
## Usage as independent script
15
+
10
16
The relevant configuration takes place in the `deploy_config` file. You can create this file either by copying `depoy_config.example` from this repository, or directly using your preferred text editor. Its format is as follows:
11
17
12
18
```
@@ -23,10 +29,21 @@ port = 443
23
29
24
30
Everything but the password is optional, and the defaults are documented in `depoy_config.example`.
25
31
26
-
Once you've prepared `deploy_config`, you can run `deploy_freenas.py`. The intended use is that it would be called by your ACME client after issuing a certificate. With acme.sh, for example, you'd add `--deploy-hook "/path/to/deploy_freenas.py"` to your command.
32
+
Once you've prepared `deploy_config`, you can run `deploy_freenas.sh`. The intended use is that it would be called by your ACME client after issuing a certificate. With acme.sh, for example, you'd add `--deploy-hook "/path/to/deploy_freenas.sh"` to your command.
27
33
28
-
There is an optional paramter, `-c` or `--config`, that lets you specify the path to your configuration file. By default the script will try to use `deploy_config` in the script working directoy:
34
+
There is an optional parameter, `-c` or `--config`, that lets you specify the path to your configuration file. By default the script will try to use `deploy_config` in the script working directoy:
0 commit comments