Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document webserver deployment for #929 #932

Merged
merged 4 commits into from
Dec 9, 2021
Merged

Document webserver deployment for #929 #932

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f8c768
deploy.md: add info on deployment to existing server
Dec 8, 2021
10fcad1
deploy.md: improve description
Dec 8, 2021
27086a0
deploy.md: additional update
Dec 8, 2021
eba6986
deploy.md: fix __site__ -> __site, add rsync note
Dec 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/workflow/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__site

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in eba6986

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 )`.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idem

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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe here after method you could add (e.g. using rsync)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in eba6986


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

Expand Down