mirror of
https://github.com/PrivSec-dev/privsec.dev.git
synced 2024-12-12 09:14:42 -05:00
32 lines
2.4 KiB
Markdown
32 lines
2.4 KiB
Markdown
# PrivSec.dev
|
|
|
|
_\~ A practical approach to Privacy and Security \~_
|
|
|
|
[](https://app.netlify.com/sites/privsec-dev/deploys)
|
|
|
|
## Licensing
|
|
|
|
Prospective contributors are encouraged to review [CONTRIBUTING.md](/CONTRIBUTING.md), including the [Contributor License Agreement](/CONTRIBUTING.md#contributor-license-agreement).
|
|
|
|
Posts are licensed under the [Creative Commons Attribution‑ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). _Please make sure to attribute the author(s) properly and include a link to the original publication when applicable._
|
|
|
|
[Hugo](https://gohugo.io/), the static site generator used to build the site, is licensed under the [Apache License 2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).
|
|
|
|
The [WonderMod](https://github.com/Wonderfall/hugo-WonderMod) theme (and its upstream [PaperMod](https://github.com/adityatelange/hugo-PaperMod)) is licensed under the [MIT License](https://github.com/Wonderfall/hugo-WonderMod/blob/master/LICENSE). Except where otherwise noted, PrivSec.dev's modifications to WonderMod are also licensed under the MIT License.
|
|
|
|
## Hosting (Netlify)
|
|
|
|
The https://privsec.dev website is hosted by [Netlify](https://netlify.com). Netlify will automatically generate previews for pull requests and on pull request updates.
|
|
|
|
## Local Working Environment
|
|
|
|
1. Install [Git](https://git-scm.com/downloads) and [Hugo](https://gohugo.io/getting-started/installing/).
|
|
- Most users should simply use the [self‑contained Hugo executable for their platform](https://github.com/gohugoio/hugo/releases). Linux package managers often provide old versions of Hugo.
|
|
1. Clone this repository: `git clone --recurse-submodules https://github.com/PrivSec-dev/privsec.dev`.
|
|
1. Run `hugo serve` to start the local development server at (by default) `http://localhost:1313`.
|
|
- Alternatively run `hugo` to simply build the site into the `public/` directory.
|
|
|
|
- Run `git submodule update --merge` to update the [WonderMod theme](https://github.com/Wonderfall/hugo-WonderMod) to the version specified in this repo.
|
|
- Run `git submodule update --remote --merge` to update to the upstream master branch of WonderMod.
|
|
- Run `./external-blogs.sh` to pull the latest versions of certain posts from their canonical (external) sources.
|