scip/ephemerup
1
0
Fork 0
mirror of https://codeberg.org/scip/ephemerup.git synced 2025-12-17 04:30:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

upd install docs

Browse Source
This commit is contained in:
Thomas von Dein
2023-10-01 14:51:20 +02:00
parent 49eca67037
commit a7ba982c69
2 changed files with 44 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -57,9 +57,21 @@ authorize. A user can only manage uploads within that context. Think
## Installation ## Installation
Since the software is currently being developed, there are no binary ### Deploy server using pre-built docker file
releases available yet. You'll need a go build environment. Just run
`make` to build everything. A ready to use ephemerup server image is available on
[ghcr.io](https://ghcr.io/tlinden/ephemerup). Supported tags are:
`latest` or a github release tag.
To try it locally with docker:
```
docker run -dp 8080:8080 --name eph \
ghcr.io/tlinden/ephemerup:latest \
-LogLevel=info
```
### Build Dockerfile
There's a `Dockerfile` available for the server so you can build and run it using docker: There's a `Dockerfile` available for the server so you can build and run it using docker:
``` ```
@@ -68,6 +80,35 @@ docker-compose run ephemerup
``` ```
Then use the client to test it. Then use the client to test it.
### Install from binary package
Go to the [Releases](https://github.com/TLINDEN/ephemerup/releases)
page and download the latest tarball for your platform. Unpack it and
execute `make install` inside the created directory.
This installs both the server `ephemerupd` and the client `upctl`.
If you only need the client, just grab the tarball and extract just
the client, copy it to your bin folder and you're good to go.
### Deploy on Kubernetes using the Helm chart
```
helm repo add tlinden https://tlinden.github.io/ephemerup/
helm repo update
helm upgrade --install ephemerup tlinden/ephemerup --namespace ephemerup --create-namespace
```
Refer to the [chart documentation](https://github.com/TLINDEN/ephemerup/tree/main/charts/ephemerup) for help.
### Build from source
To build from source, you'll need a go build environment.
Clone the git repo
Just run `make` to build everything.
## Server Usage ## Server Usage
``` ```

24
charts/cm.yaml
View File

@@ -1,24 +0,0 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: eph-ephemerup-config
namespace: "eph"
labels:
app.kubernetes.io/name: ephemerup
helm.sh/chart: ephemerup-1.0.0
app.kubernetes.io/instance: eph
app.kubernetes.io/managed-by: Helm
annotations:
app: ephemerup
data:
listen = "8080"
bodylimit = "1024"
super = "root"
mail = {
server =
port =
from =
password =
}
apicontexts = [
]