https://github.com/vaimee/ontologies
A collection of ontologies developed by VAIMEE or available online
https://github.com/vaimee/ontologies
Last synced: about 1 month ago
JSON representation
A collection of ontologies developed by VAIMEE or available online
- Host: GitHub
- URL: https://github.com/vaimee/ontologies
- Owner: vaimee
- Created: 2025-02-25T09:59:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-05-23T17:27:44.000Z (2 months ago)
- Last Synced: 2026-05-23T19:11:40.032Z (2 months ago)
- Language: HTML
- Size: 93.8 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ontologies
A collection of ontologies developed by VAIMEE, integrating classes and properties from well-known ontologies to ensure interoperability and alignment with existing standards.
## Requirements
- Node.js 20 or newer for local HTML generation.
- npm for installing the renderer dependencies.
- Docker for building and running the nginx container locally.
- A GitHub repository with GitHub Actions enabled for CI/CD publishing to Docker Hub.
## Ontology Requirements
The renderer discovers ontology sources automatically from first-level ontology folders such as `agora/`, `jsap/`, `msg/`, `users/`, and `fsm/`.
Each ontology source should:
- Use Turtle-compatible syntax and have a `.ttl` or `.owl` extension.
- Declare one ontology resource with `rdf:type owl:Ontology` or `a owl:Ontology`.
- Define classes as `owl:Class` and properties as `owl:ObjectProperty` or `owl:DatatypeProperty`.
- Prefer `rdfs:label` and `rdfs:comment` on classes and properties so the generated documentation has readable names and descriptions.
- Prefer ontology-level metadata: `owl:title`, `dct:abstract`, and `dct:description`.
If ontology-level title, abstract, or description metadata is missing, the renderer adds fallback metadata in memory while generating HTML. The source ontology file is not modified.
## Generate HTML Documentation
Install dependencies once:
```sh
npm install --prefix rdf2html
```
Generate all ontology pages and the landing page:
```sh
npm run --prefix rdf2html build
```
The build writes generated HTML beside each ontology source and creates a `public/` directory ready to be served by nginx. The landing page uses `public/ICON_VAIMEE.svg`, `#10B1D8`, and `#0F3E65`.
## Ontology Graph Visualization
The landing page embeds a WebVOWL visualization for every ontology card.
By default the generated page uses the hosted WebVOWL service at `https://service.tib.eu/webvowl/` and passes each ontology URL with the `#iri=` parameter.
WebVOWL is not only static HTML/JavaScript for Turtle or OWL files. Loading an ontology IRI requires the OWL2VOWL conversion endpoints provided by the WebVOWL application. Because this repository publishes a static nginx container, the WebVOWL application must run separately if you want to host it yourself.
To run WebVOWL from the upstream source code:
```sh
git clone https://github.com/VisualDataWeb/WebVOWL.git
cd WebVOWL
docker build -t webvowl:v1 .
docker compose up -d
```
Expose that WebVOWL service at a public URL, for example `https://ontologies.example.com/webvowl/`, then override `window.WEBVOWL_BASE_URL` before the generated script runs or adapt `rdf2html/render.js` to use that base URL.
The ontology files must also be reachable by the WebVOWL service. Local-only URLs such as `localhost` cannot be fetched by a remote WebVOWL service.
## Build Locally
Build the nginx image:
```sh
docker build -t ontologies .
```
Run it locally:
```sh
docker run --rm -p 8080:80 ontologies
```
Open `http://localhost:8080` to browse the generated ontology documentation.
## Deploy With CI/CD
The workflow in `.github/workflows/publish.yml` builds the Docker image and publishes it to Docker Hub.
It runs automatically on pushes to `main` or `master`, and can also be started manually from the GitHub Actions tab.
### Configure Docker Hub
Create a Docker Hub repository before publishing the image. For example, create `vaimee/ontologies` from the Docker Hub web interface.
Create a Docker Hub access token from Docker Hub account settings. Use this token for automation instead of your account password.
Configure these GitHub repository settings before running the workflow:
- Secret `DOCKERHUB_USERNAME`: your Docker Hub username.
- Secret `DOCKERHUB_TOKEN`: a Docker Hub access token. Use an access token instead of your account password.
- Variable `DOCKERHUB_REPOSITORY`: the Docker Hub image name, for example `vaimee/ontologies`.
### Publish From GitHub Actions
After configuring the repository settings, push to `main` or `master`:
```sh
git push origin main
```
Or start the `Publish ontologies` workflow manually from the GitHub Actions tab.
The workflow builds the Docker image from `Dockerfile`, regenerates the ontology HTML during the Docker build, and pushes the image to Docker Hub.
The published image is tagged as:
- `:latest` for the default branch.
- `:` for branch builds.
- `:sha-` for immutable commit builds.
### Publish Manually
To build and push the image from your local machine:
```sh
docker login -u
docker build -t :latest .
docker push :latest
```
For example:
```sh
docker login -u vaimee
docker build -t vaimee/ontologies:latest .
docker push vaimee/ontologies:latest
```
Use a Docker Hub access token when Docker asks for the password.
### Build Multi-Architecture Images On macOS
Docker Desktop for macOS includes Buildx. Use it to build images for both Apple Silicon and Linux AMD64 servers.
Create and select a Buildx builder:
```sh
docker buildx create --name ontologies-builder --use
docker buildx inspect --bootstrap
```
Build and push a multi-architecture image to Docker Hub:
```sh
docker login -u
docker buildx build \
--platform linux/amd64,linux/arm64 \
-t :latest \
--push \
.
```
For example:
```sh
docker login -u vaimee
docker buildx build \
--platform linux/amd64,linux/arm64 \
-t vaimee/ontologies:latest \
--push \
.
```
Use `--push` for multi-architecture images. Docker cannot load a multi-platform manifest into the local Docker image store with `--load`.
To build only for the current Mac architecture and load it locally:
```sh
docker buildx build --platform linux/arm64 -t ontologies:local --load .
```
To build an AMD64 image on Apple Silicon and load it locally for testing:
```sh
docker buildx build --platform linux/amd64 -t ontologies:amd64 --load .
```
### Run The Published Image
To deploy the published container on a server:
```sh
docker login -u
docker pull :latest
docker run -d --name ontologies --restart unless-stopped -p 80:80 :latest
```
Replace `` and `` with your Docker Hub account and repository values.