Volt Projects

Volt Projects - An automatic documentation building and hosting service.

What does it do?

Volt Projects main purpose is to host a project's documentation. It handles the process of automatically updating and deploying a project's documentation. Volt Projects it self does not generate any static files, instead it can ingest documentation from any existing static doc builder.

Getting Started

Database Setup

For either hosting or development of Volt Projects, you will need a Postgres 17 database. You can really use whatever service you want to run Postgres, (local install, Docker, etc), as long as VP can connect to it using a connection string.

You will obviously need the database for VP and a user to access the DB.

CREATE USER voltprojects WITH INHERIT LOGIN ENCRYPTED PASSWORD 'Testing123';

CREATE DATABASE voltprojects WITH
	OWNER = 'voltprojects';

-- Execute on new DB
GRANT USAGE ON SCHEMA public TO voltprojects;

Note

Do not use this password in a production environment! If your dumb enough to not realize this, then you should definitely not be hosting a production instance.

Object Storage

Volt Project uses "object storage" for storage of project's external assets, such as images and scripts. Supported object storage providers are Azure Storage, AWS S3 (or other S3 implementations such as Cloudflare's R2) and Google Cloud Storage.

You will need to use one of these providers (or an emulator such Azurite). You will also need to configure the container to host to blobs publicly.

Configure the object storage provider using Config.ObjectStorageProvider in the appsettings for both Server and Builder. The credentials for storage providers are always provided by environment variables.

Hosting

We provide VoltProject as Docker images, one for Server and one for Builder.

• VPServer
• VPBuilder

You can run these apps together with Docker Compose, using a docker-compose.yml file like so:

version: "3.9"

services:
  server:
    image: voltstro/vpserver:latest
    container_name: vpserver
    restart: unless-stopped
    ports:
      - "8080:80"
    environment:
      - ConnectionStrings__ServerConnection
      - Config__ObjectStorageProvider__Provider
      - Config__ObjectStorageProvider__ContainerName
      - Config__ObjectStorageProvider__BasePath
      - Config__ObjectStorageProvider__SubPath
      - Config__PublicUrl
      - Config__OpenIdConfig__Authority
      - Config__OpenIdConfig__ClientId
      - Config__OpenIdConfig__ClientSecret
      - VP_AZURE_CREDENTIAL

  builder:
    image: voltstro/vpbuilder:latest
    container_name: vpbuilder
    restart: unless-stopped
    environment:
      - ConnectionStrings__BuilderConnection
      - Config__ObjectStorageProvider__Provider
      - Config__ObjectStorageProvider__ContainerName
      - Config__ObjectStorageProvider__BasePath
      - Config__ObjectStorageProvider__SubPath
      - VP_AZURE_CREDENTIAL

Build

Prerequisites

.NET 9 SDK
NodeJs 22
Postgres 17

Setup

1. Build the client project by using these commands in the src/VoltProjects.Client directory.

   pnpm install
   pnpm run build
   

2. Update appsettings.json in both Builder and Server accordingly for what you need.

3. Build the .NET projects using your IDE of choice, or dotnet build in the src/ directory.

4. Run either the Server or Builder project for it to migrate the database. You can close it once the DB has been migrated.

5. Run Builder and Server projects. Make sure everything in builder goes well. You can access the server on http://localhost:5000.

Docker-Compose

An all-in-one Docker compose file is provided in src/docker-compose.yml. This will setup Builder, Server, Postgres and Azurite for you.

Security

Please see SECURITY.md for details about security.

Authors

Voltstro - Initial work - Voltstro

License

This project is licensed under the GPL-3.0 license - see the LICENSE file for details.

The content that VoltProjects hosts may be under a different license. See that project's git repo for information on it's license.