Skip to content

Commit

Permalink
Changes to use this repo as the source for the code when deploying as…
Browse files Browse the repository at this point in the history
… selfhosted application
  • Loading branch information
torbenraab authored Jan 28, 2024
1 parent ae9c600 commit d80dab6
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 26 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<h1>OpenID Connect for Plane</h1>

This repository tries to provide OpenID Connect to Plane, because there is no official implementation until now.
If you have issues with the Authentication process please raise an issue in this repo. For every other issue please make a request in the official repo: <a href="https://github.com/makeplane/plane">here</a>.

To selfhost please follow <a href="https://github.com/torbenraab/plane/tree/preview/deploy/selfhost">these instructions</a> here as they were addapted from the original documentation to work with this implementation.

<h1>Original Information:</h1>

<br /><br />

<p align="center">
Expand Down
4 changes: 2 additions & 2 deletions deploy/1-click/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
if command -v curl &> /dev/null; then
sudo curl -sSL \
-o /usr/local/bin/plane-app \
https://raw.githubusercontent.com/makeplane/plane/${BRANCH:-master}/deploy/1-click/plane-app?token=$(date +%s)
https://raw.githubusercontent.com/torbenraab/plane/${BRANCH:-master}/deploy/1-click/plane-app?token=$(date +%s)
else
sudo wget -q \
-O /usr/local/bin/plane-app \
https://raw.githubusercontent.com/makeplane/plane/${BRANCH:-master}/deploy/1-click/plane-app?token=$(date +%s)
https://raw.githubusercontent.com/torbenraab/plane/${BRANCH:-master}/deploy/1-click/plane-app?token=$(date +%s)
fi

sudo chmod +x /usr/local/bin/plane-app
Expand Down
12 changes: 6 additions & 6 deletions deploy/1-click/plane-app
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ function download_plane() {
show_message "Downloading Plane Setup Files ✋" >&2
curl -H 'Cache-Control: no-cache, no-store' \
-s -o $PLANE_INSTALL_DIR/docker-compose.yaml \
https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/docker-compose.yml?$(date +%s)
https://raw.githubusercontent.com/torbenraab/plane/$BRANCH/deploy/selfhost/docker-compose.yml?$(date +%s)

curl -H 'Cache-Control: no-cache, no-store' \
-s -o $PLANE_INSTALL_DIR/variables-upgrade.env \
https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/variables.env?$(date +%s)
https://raw.githubusercontent.com/torbenraab/plane/$BRANCH/deploy/selfhost/variables.env?$(date +%s)

# if .env does not exists rename variables-upgrade.env to .env
if [ ! -f "$PLANE_INSTALL_DIR/.env" ]; then
Expand Down Expand Up @@ -181,7 +181,7 @@ function printUsageInstructions() {
}
function build_local_image() {
show_message "- Downloading Plane Source Code ✋" >&2
REPO=https://github.com/makeplane/plane.git
REPO=https://github.com/torbenraab/plane.git
CURR_DIR=$PWD
PLANE_TEMP_CODE_DIR=$PLANE_INSTALL_DIR/temp
sudo rm -rf $PLANE_TEMP_CODE_DIR > /dev/null
Expand All @@ -199,7 +199,7 @@ function check_for_docker_images() {
show_message "" >&2
# show_message "Building Plane Images" >&2

update_env "DOCKERHUB_USER" "makeplane"
update_env "DOCKERHUB_USER" "ghcr.io/torbenraab/plane"
update_env "PULL_POLICY" "always"
CURR_DIR=$(pwd)

Expand Down Expand Up @@ -668,15 +668,15 @@ function update_installer() {
show_message "Updating Plane Installer ✋" >&2
curl -H 'Cache-Control: no-cache, no-store' \
-s -o /usr/local/bin/plane-app \
https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/1-click/install.sh?token=$(date +%s)
https://raw.githubusercontent.com/torbenraab/plane/$BRANCH/deploy/1-click/install.sh?token=$(date +%s)

chmod +x /usr/local/bin/plane-app > /dev/null&> /dev/null
show_message "Plane Installer Updated ✅" "replace_last_line" >&2
}

export BRANCH=${BRANCH:-master}
export APP_RELEASE=$BRANCH
export DOCKERHUB_USER=makeplane
export DOCKERHUB_USER=ghcr.io/torbenraab/plane
export PULL_POLICY=always

PLANE_INSTALL_DIR=/opt/plane
Expand Down
4 changes: 2 additions & 2 deletions deploy/coolify/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Coolify Setup

Access the `coolify-docker-compose` file [here](https://raw.githubusercontent.com/makeplane/plane/master/deploy/coolify/coolify-docker-compose.yml) or download using using below command
Access the `coolify-docker-compose` file [here](https://raw.githubusercontent.com/torbenraab/plane/master/deploy/coolify/coolify-docker-compose.yml) or download using using below command

```
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/coolify/coolify-docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/torbenraab/plane/master/deploy/coolify/coolify-docker-compose.yml
```
20 changes: 14 additions & 6 deletions deploy/coolify/coolify-docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ services:
web:
container_name: web
platform: linux/amd64
image: makeplane/plane-frontend:latest
image: ghcr.io/torbenraab/plane/plane-frontend:latest
restart: always
command: /usr/local/bin/start.sh web/server.js web
environment:
Expand All @@ -15,7 +15,7 @@ services:
space:
container_name: space
platform: linux/amd64
image: makeplane/plane-space:latest
image: ghcr.io/torbenraab/plane/plane-space:latest
restart: always
command: /usr/local/bin/start.sh space/server.js space
environment:
Expand All @@ -28,7 +28,7 @@ services:
api:
container_name: api
platform: linux/amd64
image: makeplane/plane-backend:latest
image: ghcr.io/torbenraab/plane/plane-backend:latest
restart: always
command: ./bin/takeoff
environment:
Expand Down Expand Up @@ -69,14 +69,22 @@ services:
- ENABLE_MAGIC_LINK_LOGIN=${ENABLE_MAGIC_LINK_LOGIN:-0}
- SECRET_KEY=${SECRET_KEY:-60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5}
- WEB_URL=$SERVICE_FQDN_PLANE_8082
- OIDC_AUTO=${OIDC_AUTO:-0}
- OIDC_CLIENT_ID=${OIDC_CLIENT_ID:-""}
- OIDC_CLIENT_SECRET=${OIDC_CLIENT_SECRET:-""}
- OIDC_DISCOVERY=${OIDC_DISCOVERY:-""}
- OIDC_URL_AUTHORIZATION=${OIDC_URL_AUTHORIZATION:-""}
- OIDC_URL_TOKEN=${OIDC_URL_TOKEN:-""}
- OIDC_URL_USERINFO=${OIDC_URL_USERINFO:-""}
- OIDC_URL_ENDSESSION=${OIDC_URL_ENDSESSION:-""}
depends_on:
- plane-db
- plane-redis

worker:
container_name: bgworker
platform: linux/amd64
image: makeplane/plane-backend:latest
image: ghcr.io/torbenraab/plane/plane-backend:latest
restart: always
command: ./bin/worker
environment:
Expand Down Expand Up @@ -122,7 +130,7 @@ services:
beat-worker:
container_name: beatworker
platform: linux/amd64
image: makeplane/plane-backend:latest
image: ghcr.io/torbenraab/plane/plane-backend:latest
restart: always
command: ./bin/beat
environment:
Expand Down Expand Up @@ -211,7 +219,7 @@ services:
proxy:
container_name: proxy
platform: linux/amd64
image: makeplane/plane-proxy:latest
image: ghcr.io/torbenraab/plane/plane-proxy:latest
ports:
- 8082:80
environment:
Expand Down
11 changes: 11 additions & 0 deletions deploy/kubernetes/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Helm Chart

## Work with OpenID Connect

You have to set the following variables to make the kubernetes deployment work with the images build here:

```
dockerhub.images.backend=ghcr.io/torbenraab/plane/plane-backend
dockerhub.images.space=ghcr.io/torbenraab/plane/plane-space
dockerhub.images.frontend=ghcr.io/torbenraab/plane/plane-frontend
```

Click on the below link to access the helm chart instructions.

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/makeplane)](https://artifacthub.io/packages/search?repo=makeplane)
6 changes: 3 additions & 3 deletions deploy/selfhost/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ mkdir plane-selfhost
cd plane-selfhost
curl -fsSL -o setup.sh https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh
curl -fsSL -o setup.sh https://raw.githubusercontent.com/torbenraab/plane/master/deploy/selfhost/install.sh
chmod +x setup.sh
```
Expand All @@ -77,7 +77,7 @@ cd plane-selfhost
export RELEASE=preview
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/install.sh | sed 's@BRANCH=master@BRANCH='"$RELEASE"'@' > setup.sh
curl -fsSL https://raw.githubusercontent.com/torbenraab/plane/$BRANCH/deploy/selfhost/install.sh | sed 's@BRANCH=master@BRANCH='"$RELEASE"'@' > setup.sh
chmod +x setup.sh
```
Expand Down Expand Up @@ -251,7 +251,7 @@ Begin with downloading the migration script using below command

```
curl -fsSL -o migrate.sh https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/migration-0.13-0.14.sh
curl -fsSL -o migrate.sh https://raw.githubusercontent.com/torbenraab/plane/master/deploy/selfhost/migration-0.13-0.14.sh
chmod +x migrate.sh
Expand Down
10 changes: 5 additions & 5 deletions deploy/selfhost/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ BRANCH=master
SCRIPT_DIR=$PWD
PLANE_INSTALL_DIR=$PWD/plane-app
export APP_RELEASE=$BRANCH
export DOCKERHUB_USER=makeplane
export DOCKERHUB_USER=ghcr.io/torbenraab/plane
export PULL_POLICY=always
USE_GLOBAL_IMAGES=1

Expand Down Expand Up @@ -39,7 +39,7 @@ function buildLocalImage() {

if [ "$DO_BUILD" == "1" ] || [ "$DO_BUILD" == "" ];
then
REPO=https://github.com/makeplane/plane.git
REPO=https://github.com/torbenraab/plane.git
CURR_DIR=$PWD
PLANE_TEMP_CODE_DIR=$(mktemp -d)
git clone $REPO $PLANE_TEMP_CODE_DIR --branch $BRANCH --single-branch
Expand Down Expand Up @@ -79,8 +79,8 @@ function download() {
mv $PLANE_INSTALL_DIR/docker-compose.yaml $PLANE_INSTALL_DIR/archive/$TS.docker-compose.yaml
fi

curl -H 'Cache-Control: no-cache, no-store' -s -o $PLANE_INSTALL_DIR/docker-compose.yaml https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/docker-compose.yml?$(date +%s)
curl -H 'Cache-Control: no-cache, no-store' -s -o $PLANE_INSTALL_DIR/variables-upgrade.env https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/variables.env?$(date +%s)
curl -H 'Cache-Control: no-cache, no-store' -s -o $PLANE_INSTALL_DIR/docker-compose.yaml https://raw.githubusercontent.com/torbenraab/plane/$BRANCH/deploy/selfhost/docker-compose.yml?$(date +%s)
curl -H 'Cache-Control: no-cache, no-store' -s -o $PLANE_INSTALL_DIR/variables-upgrade.env https://raw.githubusercontent.com/torbenraab/plane/$BRANCH/deploy/selfhost/variables.env?$(date +%s)

if [ -f "$PLANE_INSTALL_DIR/.env" ];
then
Expand Down Expand Up @@ -197,7 +197,7 @@ ARCH=$(uname -m)
if [ $ARCH == "amd64" ] || [ $ARCH == "x86_64" ];
then
USE_GLOBAL_IMAGES=1
DOCKERHUB_USER=makeplane
DOCKERHUB_USER=ghcr.io/torbenraab/plane
PULL_POLICY=always
else
USE_GLOBAL_IMAGES=0
Expand Down
2 changes: 0 additions & 2 deletions deploy/selfhost/variables.env
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,3 @@ FILE_SIZE_LIMIT=5242880

# Gunicorn Workers
GUNICORN_WORKERS=2

DOCKERHUB_USER=ghcr.io/torbenraab/plane

0 comments on commit d80dab6

Please sign in to comment.