aboutsummaryrefslogtreecommitdiff
path: root/doc/book/connect/websites.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2022-02-01 17:39:35 +0100
committerAlex Auvolat <alex@adnab.me>2022-02-07 16:01:45 +0100
commit5a1fb7cce732a5eaffa4d5683cfabcd2d0d6dd7d (patch)
tree99cdc7d40916cf15e6409b1e3edfa0dd92a1e7f4 /doc/book/connect/websites.md
parent1c0ba930b8d6aa5d97e6942852240861e6ab9bed (diff)
downloadgarage-5a1fb7cce732a5eaffa4d5683cfabcd2d0d6dd7d.tar.gz
garage-5a1fb7cce732a5eaffa4d5683cfabcd2d0d6dd7d.zip
Improve integration part of the doc
Diffstat (limited to 'doc/book/connect/websites.md')
-rw-r--r--doc/book/connect/websites.md39
1 files changed, 22 insertions, 17 deletions
diff --git a/doc/book/connect/websites.md b/doc/book/connect/websites.md
index 3f62c9a6..6a6d3185 100644
--- a/doc/book/connect/websites.md
+++ b/doc/book/connect/websites.md
@@ -6,6 +6,12 @@ weight = 10
Garage is also suitable to host static websites.
While they can be deployed with traditional CLI tools, some static website generators have integrated options to ease your workflow.
+| Name | Status | Note |
+|------|--------|------|
+| [Hugo](#hugo) | ✅ | Publishing logic is integrated in the tool |
+| [Publii](#publii) | ✅ | Require a correctly configured s3 vhost endpoint |
+| [Generic Static Site Generator](#generic-static-site-generator) | ✅ | Works for Jekyll, Zola, Gatsby, Pelican, etc. |
+
## Hugo
Add to your `config.toml` the following section:
@@ -42,39 +48,38 @@ hugo deploy
## Publii
-It would require a patch either on Garage or on Publii to make both systems work.
+[![A screenshot of Publii's GUI](./publii.png)](./publii.png)
-Currently, the proposed workaround is to deploy your website manually:
- - On the left menu, click on Server, choose Manual Deployment (the logo looks like a compressed file)
- - Set your website URL, keep Output type as "Non-compressed catalog"
- - Click on Save changes
- - Click on Sync your website (bottom left of the app)
- - On the new page, click again on Sync your website
- - Click on Get website files
- - You need to synchronize the output folder you see in your file explorer, we will use minio client.
+Deploying a website to Garage from Publii is natively supported.
+First, make sure that your Garage administrator allowed and configured Garage to support vhost access style.
+We also suppose that your bucket ("my-bucket") and key is already created and configured.
-Be sure that you [configured minio client](@/documentation/connect/cli.md#minio-client-recommended).
+Then, from the left menu, click on server. Choose "S3" as the protocol.
+In the configuration window, enter:
+ - Your finale website URL (eg. "http://my-bucket.web.garage.localhost:3902")
+ - Tick "Use a custom S3 provider"
+ - Set the S3 endpoint, (eg. "http://s3.garage.localhost:3900")
+ - Then put your access key (eg. "GK..."), your secret key, and your bucket (eg. "my-bucket")
+ - And hit the button "Save settings"
+
+Now, each time you want to publish your website from Publii, just hit the bottom left button "Sync your website"!
-Then copy this output folder
-```bash
-mc mirror --overwrite output garage/my-site
-```
-## Generic (eg. Jekyll)
+## Generic Static Site Generator
Some tools do not support sending to a S3 backend but output a compiled folder on your system.
We can then use any CLI tool to upload this content to our S3 target.
First, start by [configuring minio client](@/documentation/connect/cli.md#minio-client-recommended).
-Then build your website:
+Then build your website (example for jekyll):
```bash
jekyll build
```
-And copy jekyll's output folder on S3:
+And copy its output folder (`_site` for Jekyll) on S3:
```bash
mc mirror --overwrite _site garage/my-site