sw360.website

Learn more »

Discussions · Website · Issues . Documentation · GSoC

The website is based on the Hugo static page generator. All relevant source files can be found at github.com/eclipse/sw360.website. The page is published at eclipse.org/sw360 and built with a Jenkins job, which is configured in a jenkins file in the repository of the website.

If you want to add content to the page, please checkout the git repository (https://github.com/eclipse/sw360.website.git) and add your content.

The page will be build as soon as you push to upstream main branch. There is also a staging area at the Eclipse Foundation page at staging.eclipse.org/sw360, which is protected by your Eclipse Foundation user credentials and filled with the content that is found at the staging branch in https://github.com/eclipse/sw360.website. If you want to check out your changes first, just push to the staging branch. The content is published the same way as with the main branch.

The Jenkins instance is operated by the Eclipse Foundation and can be found here: https://jenkins.eclipse.org/sw360/job/sw360.website/. The result of the Jenkins build is pushed to: http://git.eclipse.org/c/www.eclipse.org/sw360.git.

The Jenkins job checks for changes in the repository every 15 minutes.If it detects changes it will start the Hugo build and copy the generated static html files to git.eclipse.org. From there another job fetches the files and copies them to the actual static webspace of the Eclipse Foundation.

SW360 Website Setup Guide

This guide provides instructions to set up and run the SW360 website locally using Docker.

Table of Contents

• Prerequisites
• Installation Guide Using Docker
• Troubleshooting
• Project Structure
• Support

---

Prerequisites

Before you begin, make sure Docker is installed and running on your system.

• Verify installation by running:

  docker --version

Installation Guide Using Docker

Set Up the Local Server

Linux/macOS Setup

1. Open a terminal and ensure you’re in the project root directory.
2. Run the Docker script to start the local server:

   bash docker_serve_local.sh

3. Once the server starts, open your browser and visit:

   http://localhost:1313/sw360
   

4. Changes to the code will automatically reload in the browser.

Windows Setup

1. Ensure Docker Desktop is Running: Open Docker Desktop and confirm the Docker engine is active.
2. Choose one of the following methods:

1: Using Git Bash

1. Make the script executable (if needed):

   chmod +x docker_serve_local.sh

2. Run the script:

   bash docker_serve_local.sh

2: Using WSL

1. Ensure WSL is installed and Docker Desktop is configured for WSL 2 integration:
   • In Docker Desktop, go to Settings > Resources > WSL Integration and enable your Linux distribution.
2. Make the script executable (if needed):

   chmod +x docker_serve_local.sh

3. Run the script:

   bash docker_serve_local.sh

4. Once running, access the site at http://localhost:1313/sw360 (check the script output for the exact port).

Note: The Hugo development server includes live reload functionality. Any changes to content or layouts will update in real-time, enabling rapid development and testing.

Troubleshooting

1. Permission Denied

   Issue: Permission denied when running docker_serve_local.sh Solution:

   1. Grant execute permissions:

      chmod +x docker_serve_local.sh

   2. Retry:

      bash docker_serve_local.sh

2. Line Ending Errors

   Issue: $'r': command not found (common when the script has Windows-style line endings) Solution:

   1. Convert the script to Unix format:

      dos2unix docker_serve_local.sh

   2. Run it again:

      bash docker_serve_local.sh

Project Structure

sw360.website/
├── content/               # Website content (pages, posts, etc.)
├── layouts/               # Custom layout templates
├── static/                # Static assets (images, CSS, JS)
├── config.toml            # Hugo configuration
├── docker_serve_local.sh  # Docker development script
└── README.md              # Project documentation and contribution guidelines

Support

• Report issues: GitHub Issues
• Community: SW360 Mailing List
• Documentation: SW360 Documentation