From 65c3bde490f77822715afe540bf4c56d82e1444e Mon Sep 17 00:00:00 2001 From: gavinband Date: Thu, 9 Dec 2021 07:10:33 +0000 Subject: [PATCH] Document webserver deployment for #929 (#932) --- docs/workflow/deploy.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/workflow/deploy.md b/docs/workflow/deploy.md index 27bf517bc..4883fca3d 100644 --- a/docs/workflow/deploy.md +++ b/docs/workflow/deploy.md @@ -12,7 +12,19 @@ reviewed: 18/10/20 \lineskip -Deploying the website is trivial on GitHub, Gitlab and services like Netlify. +Deploying the website is trivial on an existing webserver, via GitHub or Gitlab, or on services like Netlify. + +## Deploying on an existing webserver + +The contents of the `__site` folder can simply be deployed to a path on an existing server as follows. +Supposing you wish your site to appear at `http://my.example.com/path/to/my/franklin/site/`. You would take the following steps: + +* Prepare the `__site` directory by running `optimize( prepath='/path/to/my/franklin/site/', minify = false )`. +Franklin.jl does not use relative links, so this step is needed to ensure that the links between site elements are correct. (The `minify = false` argument is optional but is currently recommended.) + +* Copy the contents of the `__site` directory to the target location using your chosen method (for example, using [rsync](https://en.wikipedia.org/wiki/Rsync)). + +Your site should now be live, with the index page appearing at `http://my.example.com/path/to/my/franklin/site/index.html`. ## Deploying on GitHub