website

(β˜… 65)

The Flux website and user documentation

File Explorer

Download Latest Version (.zip)
  • .editorconfig
  • .gitignore
  • .stignore
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • DCO
  • Dockerfile
  • go.mod
  • go.sum
  • hugo.yaml
  • LICENSE
  • lychee.toml
  • MAINTAINERS
  • Makefile
  • netlify.toml
  • okteto.yml
  • package-lock.json
  • package.json
  • README.md
  • requirements.txt
  • runtime.txt

# Installation Guide

1. Get the code
git clone https://github.com/fluxcd/website

Downloads the entire project code from GitHub to your computer.

cd website

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t website .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 website

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make serve

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

Today's picks

gitignore β˜… 175,385

A collection of useful .gitignore templates
free-for-dev β˜… 132,878

A list of SaaS, PaaS and IaaS offerings that have free tiers of interest to devops and inf

HTML
FreeDomain β˜… 194,714

Free domain registration and practical DNS learning resources for everyone.

Markdown
Understand-Anything β˜… 80,004

Graphs that teach > graphs that impress. Turn any code into an interactive knowledge graph

TypeScript
fastapi β˜… 101,743

FastAPI framework, high performance, easy to learn, fast to code, ready for production

Python
syncthing β˜… 87,847

Open Source Continuous File Synchronization

Go
// repository documentation