ownForge Documentation
Status: Pre-Alpha
Brought to you by:
labi
Menu
▾
▴
Home
What is ownForge?
Allura is the open source hosting platform, source forge has invented and where it is still running on.
It is open source and part of the apache project. But sadly Allura is very difficult to configure and to get to production state. ownForge is a toolset, which can help you to get production grade docker images of Allura.
How can I customize the Docker images?
ownForge consists of a set of container images, which are working together. These are:
- Allura
- MongoDB
- SOLR
- Apache (for SVN/Git access)
- nginx (as reverse proxy and for certificate handling)
Usually you would need to configure your server and each of the services consistently, that they are cooperating.
To keep the configuration simple, with ownForge, there is a set of config files in one folder, that provide you a limited set of configurations.
Just check the folder, named "config".
Neighbourhoods
In Allura everything is managed in projects. The top level projects are named "neighbourhoods" and can be used as rough categories, as the neighbourhoods can have different defaults and restrictions for their project.
As allura doesn't provide a user interface to create your beighbourhoods, you can use the config file "neighborhoods.yml".
Troves / Categories
Another thing, that is hard to configure are the so called "Troves" . Those are different categories, like "Topic", "DB" or "License".
To define your categories, you can use the config file "trovecategories.yml".
Allura Configuration / development.ini
When reading some documentations about Allura, you find nany references to the file "development.ini".
Actually this name is not fix, why we named it "allura.ini". But in our case most of the config is fix, as we configured it for our docker environment.
The bits which can be changed can be configured in the file "allura.env".
Installation
ownForge is nothing more than a build environment. If you check it out and type "make all", it will already build all images and start all containers.
More ownForge commands
- "make start" is starting all currently build images
- "make stop" stops all running containers
- "make logs" shows the logs of all containers
- "make clean" deletes the current data
- "make build" rebuilds the.containers
- "make data" regenerates the default databases, repositories and pythons virtual env
- "make export" saves all currently active images in the subfolder "images/"
- "make import" impors all images from the subfolder "images/"
- "./scripts/extensions.sh" can be used to enable or disable Allura extensions.
Data Volumes
All data of allura and all of its services is placed in the folder /allura-data of the host. This makes it easy to backup all databases and repositories.
By default, the containers are started with a development configuration, where the local source code is also mounted into the containers. That makes it easy to make tests with the scripts and the styles.
To apply those changes into the containers, you need to rebuild them.
How to customize Themes?
In Allura themes have to be implemented as an extension. ownForge defines such an extension, which provides a better default than the usual limited and very old school Allura theme.
You can either write your own extension or simply extend the ownForge theme, found in *extension/ThemeOwnForge".
Mail Server integration
Sending notifications from Allura is as simple as specifying your SMTP credentials in "allura.yml".
Install SSL certificates
Place your certificates into "configuration/cert".
