From a07b790589d154e952eff8bea2abae40f0655bec Mon Sep 17 00:00:00 2001
From: Anthony Hughes <peacock@lucidcocoon.scot>
Date: Fri, 22 Mar 2024 18:56:59 +0000
Subject: [PATCH] Update install instructions to reference Forgejo instead of
 Gitea

---
 README.md | 48 ++++++++++++++++++++++++++++++++----------------
 1 file changed, 32 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 4c18cf3..93e79ea 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,51 @@
-# Gitea Cloudron App
-
-This repository contains the Cloudron app package source for [Gitea](http://gitea.io/).
+# Forgejo Cloudron App
+This repository contains the Cloudron app package source for [Forgejo](https://forgejo.org/).
 
 ## Installation
+Per the Cloudron [packaging guidelines](https://docs.cloudron.io/packaging/publishing/), 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](https://forum.cloudron.io/post/80377). 
 
-[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp)
+The app expects to use port `29418`, so please ensure you have no Cloudron apps installed that are using that port.
 
-or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
+To install, please set up [Cloudron CLI](https://cloudron.io/references/cli.html) on your system and then follow these instructions:
 
+#### 1. Log in to Docker
+Set up an account on [Docker Hub](https://hub.docker.com) if you don't already have one.
+
+From terminal:
 ```
-cloudron install --appstore-id io.gitea.cloudronapp
+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
 ```
 
-## Building
-
-The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
-
+#### 2. Build the docker image
 ```
-cd gitea-app
-
-cloudron build
-cloudron install
+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](http://nodejs.org/). 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 gitea-app/test
-
+cd forgejo-cloudron-app/test
 npm install
 PATH=$PATH:node_modules/.bin USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test.js
 ```