Skip to content

Running the Project Website

Goal: Making project website (documentation) changes you can also use the example Flamenco Development Container to run hugo.

Assumptions: 1. You want to make live changes to a working copy and see the results locally. 2. You want to use the Flamenco Development Container to run hugo and not install it on the host workstation.

There are two options when running the project-website from the Flamenco Dev Container.

  1. Packaged (in Container)
  2. Working-Copy

Depending on your needs/testing one may suit you better. If you are making live changes and inspecting them then Option 2 is very helpful.

Option 1 - Open Container project-website

You can serve the project documentation after the Dev Container has been built to verify it is as expected.

docker run -w /code/web/project-website -p 1313:1313 --name flamenco_dev -it flamenco_dev hugo server -D --bind 0.0.0.0

Option 2 - Open Working Copy

You can use toolchain from the Dev Container but the local working-copy project to make live edits.

docker run -v $PWD/:/code -w /code/web/project-website -p 1313:1313 --name flamenco_dev -it flamenco_dev hugo server -D --bind 0.0.0.0

Example Dev Container Logs

When the hugo is launched you should see something like the following whether you use Option 1 or 2.

Start building sites … 
hugo v0.92.2+extended linux/amd64 BuildDate=2023-01-31T11:11:57Z VendorInfo=ubuntu:0.92.2-1ubuntu0.1

                   | EN   
-------------------+------
  Pages            |  60  
  Paginator pages  |   0  
  Non-page files   |   2  
  Static files     | 132  
  Processed images |   0  
  Aliases          |   1  
  Sitemaps         |   1  
  Cleaned          |   0  

Built in 163 ms
Watching for changes in /code/web/project-website/{archetypes,content,data,layouts,static,themes}
Watching for config changes in /code/web/project-website/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)