|
@@ -6,39 +6,41 @@
|
|
|
|
|
|
## Installation and Usage
|
|
## Installation and Usage
|
|
|
|
|
|
-**Option A) Build**
|
|
|
|
|
|
+**Option A:** Build it
|
|
|
|
|
|
Requirements: go 1.11+
|
|
Requirements: go 1.11+
|
|
|
|
|
|
-**Step 1: Install `hugo-encrypt`.**
|
|
|
|
|
|
+**Step 1:** Install `hugo-encrypt`.
|
|
|
|
|
|
$ go get github.com/Izumiko/hugo-encrypt
|
|
$ go get github.com/Izumiko/hugo-encrypt
|
|
|
|
|
|
-**Step 2: Place `shortcodes/hugo-encrypt.html` in the shortcode directory of your blog:**
|
|
|
|
|
|
+**Step 2:** Place `shortcodes/hugo-encrypt.html` in the shortcode directory of your blog:
|
|
|
|
|
|
$ mkdir -p /path/to/your/blog/layouts/shortcodes
|
|
$ mkdir -p /path/to/your/blog/layouts/shortcodes
|
|
$ cp shortcodes/hugo-encrypt.html /path/to/your/blog/layouts/shortcodes/hugo-encrypt.html
|
|
$ cp shortcodes/hugo-encrypt.html /path/to/your/blog/layouts/shortcodes/hugo-encrypt.html
|
|
|
|
|
|
-**Step 3: Merge i18n translation files and/or add your own language.**
|
|
|
|
|
|
+**Step 3:** Merge i18n translation files and/or add your own language.
|
|
|
|
|
|
$ cp -r i18n /path/to/your/blog/
|
|
$ cp -r i18n /path/to/your/blog/
|
|
|
|
|
|
-**Step 4: Use hugo-encrypt to encrypt content
|
|
|
|
|
|
+**Step 4:** Use hugo-encrypt to encrypt content**
|
|
|
|
|
|
$ export PATH=/path/to/hugo-encrypt/:$PATH
|
|
$ export PATH=/path/to/hugo-encrypt/:$PATH
|
|
|
|
+ $ hugo
|
|
$ hugo-encrypt -sitePath /path/to/hugo/public
|
|
$ hugo-encrypt -sitePath /path/to/hugo/public
|
|
|
|
|
|
-**Option B) Use docker
|
|
|
|
|
|
+**Option B:** Use docker
|
|
|
|
|
|
Requirements: docker
|
|
Requirements: docker
|
|
|
|
|
|
|
|
+ $ hugo
|
|
$ docker run -it --rm \
|
|
$ docker run -it --rm \
|
|
-v /path/to/hugo/public:/data/site \
|
|
-v /path/to/hugo/public:/data/site \
|
|
chaosbunker/hugo-encrypt hugo-encrypt -sitePath /data/site`
|
|
chaosbunker/hugo-encrypt hugo-encrypt -sitePath /data/site`
|
|
|
|
|
|
-## Using the `{{< hugo-encrypt >}}` tag in your blog posts
|
|
|
|
|
|
+## Setting a password and using the `{{< hugo-encrypt >}}` tag in your blog posts
|
|
|
|
|
|
-**Option 1: Setting the password in your blogs config file**
|
|
|
|
|
|
+**Option 1:** Setting the password in your blogs config file
|
|
|
|
|
|
```
|
|
```
|
|
[params]
|
|
[params]
|
|
@@ -57,7 +59,7 @@ This content will be encrypted!
|
|
{{< /hugo-encrypt >}}
|
|
{{< /hugo-encrypt >}}
|
|
```
|
|
```
|
|
|
|
|
|
-**Option 2: Setting a spexcific password in the shortcode**
|
|
|
|
|
|
+**Option 2:** Setting a spexcific password in the shortcode
|
|
|
|
|
|
```markdown
|
|
```markdown
|
|
---
|
|
---
|
|
@@ -71,26 +73,11 @@ This content will also be encrypted!
|
|
{{< /hugo-encrypt >}}
|
|
{{< /hugo-encrypt >}}
|
|
```
|
|
```
|
|
|
|
|
|
-**Step 2: Generate your site as usual**
|
|
|
|
-
|
|
|
|
-It may be something like:
|
|
|
|
-
|
|
|
|
- $ hugo
|
|
|
|
-
|
|
|
|
-**Step 3: Get the encryption done**
|
|
|
|
-
|
|
|
|
- $ ./hugo-encrypt
|
|
|
|
-
|
|
|
|
- or (if added to PATH)
|
|
|
|
-
|
|
|
|
- $ hugo-encrypt
|
|
|
|
-
|
|
|
|
-
|
|
|
|
-Now all the private posts in your `public` directory are encrypted.
|
|
|
|
|
|
+After generating the site with `hugo` and running `hugo-encrypt` all the private posts in your `public` directory are encrypted and the site can be published.
|
|
|
|
|
|
## Configuration
|
|
## Configuration
|
|
|
|
|
|
-Although `hugo-encrypt` works right out of the box, there are a few things that can be customized to your liking.
|
|
|
|
|
|
+Although `hugo-encrypt` works right out of the box, there are a few things that can be customized.
|
|
.
|
|
.
|
|
### Language
|
|
### Language
|
|
|
|
|