forgejo-cloudron-app/README.md

1.9 KiB

Forgejo Cloudron App

This repository contains the Cloudron app package source for Forgejo.

Installation

Per the Cloudron packaging guidelines, this app is not packaged for the Cloudron app store and will not be until the Cloudron team decides they're willing to take on the maintenance burden.

The app expects to use port 29418, so please ensure you have no Cloudron apps installed that are using that port.

To install, please set up Cloudron CLI on your system and then follow these instructions:

1. Log in to Docker

Set up an account on Docker Hub if you don't already have one.

From terminal:

sudo docker login

Enter your Docker username and password when prompted.

3. Get the code

git clone https://forge.lucidcocoon.scot/peacock/forgejo-cloudron-app.git
cd forgejo-cloudron-app

2. Build the docker image

sudo docker build -t <username>/forgejo-cloudron-app:<version> .

3. Push the image to Docker

sudo docker push forgejo-cloudron-app:<version>

4. Install your Docker image to Cloudron

cloudron install --image <username>/forgejo-cloudron-app:<version>
Location: <app.domain.tld>

Open your browser to your Cloudron dashboard and you should see the app install. It may take a few minutes.

Testing

The e2e tests are located in the test/ folder and require nodejs. They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the repos are still ok. The tests expect port 29418 to be available.

cd forgejo-cloudron-app/test
npm install
PATH=$PATH:node_modules/.bin USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test.js