https://github.com/cfengine/build-website
CFEngine Build Website repo
https://github.com/cfengine/build-website
Last synced: 15 days ago
JSON representation
CFEngine Build Website repo
- Host: GitHub
- URL: https://github.com/cfengine/build-website
- Owner: cfengine
- License: mit
- Created: 2019-11-06T18:50:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-03-04T00:48:12.000Z (20 days ago)
- Last Synced: 2026-03-04T05:34:19.351Z (20 days ago)
- Language: Less
- Homepage: https://build.cfengine.com
- Size: 2.08 MB
- Stars: 0
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CFEngine Build website
The website lists available modules from the index and gives you easy commands to copy.
## Deployment workflow
1. Create your own branch / fork based on master branch.
2. Make changes locally and preview with docker / hugo.
3. Submit a PR to `cfengine:master` - once reviewed and merged see results here: https://staging.build.cfengine.com/
4. Create a new PR from `cfengine:master` to `cfengine:production` here: https://github.com/cfengine/build-website/compare/production...master
5. Merge to deploy (after seeing it working on staging site).
## Dependencies
[Hugo](https://gohugo.io/).
[Lunr](https://lunrjs.com/).
[Node.js](https://nodejs.dev/).
## Build
```
export GITHUB_USERNAME_TOKEN='place githubName:token here'
npm ci
npm run build
npm run create-modules-json
hugo
```
## Serve
```
cd public
python3 -m http.server
or
hugo serve
```
## Container
Using docker / podman to build and serve is fairly straight forward:
```
export GITHUB_USERNAME_TOKEN='place githubName:token here'
docker build --build-arg GITHUB_USERNAME_TOKEN --tag cfengine-build-website -f Dockerfile . && docker run -it -p 80:80 -p 81:81 --volume ./proxy:/home/proxy --name cfengine-build-website --rm cfengine-build-website
```
## CFEngine Build repositories
* [build-index](https://github.com/cfengine/build-index) - Index of modules
* [build-website](https://github.com/cfengine/build-website) - Website
* [cfbs](https://github.com/cfengine/cfbs) - Command line client
* [modules](https://github.com/cfengine/modules) - Official modules provided by the CFEngine team
* [module-template](https://github.com/cfengine/build-example) - Template for creating new modules