refactor: Remove ng suffix as this is now main

Author: pojntfx

.github/workflows/docker.yaml

@@ -30,9 +30,9 @@ jobs:
           file: ./Dockerfile
           platforms: linux/amd64,linux/arm64/v8
           push: true
-          tags: pojntfx/pojde-ng:latest
+          tags: pojntfx/pojde:latest
           build-args: |
-            POJDE_NG_OPENRC=false
+            POJDE_OPENRC=false
   build-openrc:
     runs-on: ubuntu-latest
 
@@ -56,6 +56,6 @@ jobs:
           file: ./Dockerfile
           platforms: linux/amd64,linux/arm64/v8
           push: true
-          tags: pojntfx/pojde-ng:latest-openrc
+          tags: pojntfx/pojde:latest-openrc
           build-args: |
-            POJDE_NG_OPENRC=true
+            POJDE_OPENRC=true

Dockerfile

@@ -1,15 +1,15 @@
 FROM debian:10
 
 # Choose init system
-ARG POJDE_NG_OPENRC='false'
-ENV POJDE_NG_OPENRC ${POJDE_NG_OPENRC}
+ARG POJDE_OPENRC='false'
+ENV POJDE_OPENRC ${POJDE_OPENRC}
 
 # Disable interactive prompts
 ENV DEBIAN_FRONTEND noninteractive
 
 # Setup environment
-RUN mkdir -p /opt/pojde-ng/build
-WORKDIR /opt/pojde-ng/build
+RUN mkdir -p /opt/pojde/build
+WORKDIR /opt/pojde/build
 
 # Run build scripts
 COPY build/repositories.sh .
@@ -51,23 +51,23 @@ RUN ./webwormhole.sh
 COPY build/clean.sh .
 RUN ./clean.sh
 
-# Add `pojdectl-ng`
+# Add `pojdectl`
 COPY bin/* /usr/bin/
 
 # Clean up
-RUN rm -rf /opt/pojde-ng/build
+RUN rm -rf /opt/pojde/build
 
 # Create preferences & CA directories
-RUN mkdir -p /opt/pojde-ng/preferences
-RUN mkdir -p /opt/pojde-ng/ca
+RUN mkdir -p /opt/pojde/preferences
+RUN mkdir -p /opt/pojde/ca
 
 # Add configuration scripts
-RUN mkdir -p /opt/pojde-ng/configuration
-COPY configuration/* /opt/pojde-ng/configuration/
+RUN mkdir -p /opt/pojde/configuration
+COPY configuration/* /opt/pojde/configuration/
 
 # Add module scripts
-RUN mkdir -p /opt/pojde-ng/modules
-COPY modules/* /opt/pojde-ng/modules/
+RUN mkdir -p /opt/pojde/modules
+COPY modules/* /opt/pojde/modules/
 
 # Go back to home dir
 WORKDIR /root

Makefile

@@ -9,16 +9,16 @@ pre:
 	chmod +x ./modules/*.sh
 
 build: pre
-	docker build --build-arg POJDE_NG_OPENRC=false -t pojntfx/pojde-ng:latest .
+	docker build --build-arg POJDE_OPENRC=false -t pojntfx/pojde:latest .
 
 build-openrc: pre
-	docker build --build-arg POJDE_NG_OPENRC=true -t pojntfx/pojde-ng:latest-openrc .
+	docker build --build-arg POJDE_OPENRC=true -t pojntfx/pojde:latest-openrc .
 
 link: pre
-	sudo ln -sf "$(shell pwd)/bin/pojdectl-ng" /usr/local/bin/pojdectl-ng
+	sudo ln -sf "$(shell pwd)/bin/pojdectl" /usr/local/bin/pojdectl
 
 install:
-	sudo install bin/pojdectl-ng /usr/local/bin
+	sudo install bin/pojdectl /usr/local/bin
 
 uninstall:
 	sudo rm /usr/local/bin/pojdectl

README.md

@@ -1,6 +1,6 @@
-# pojde Next Generation (pojde-ng)
+# pojde
 
-[![Docker CI](https://github.com/pojntfx/pojde-ng/actions/workflows/docker.yaml/badge.svg)](https://github.com/pojntfx/pojde-ng/actions/workflows/docker.yaml)
+[![Docker CI](https://github.com/pojntfx/pojde/actions/workflows/docker.yaml/badge.svg)](https://github.com/pojntfx/pojde/actions/workflows/docker.yaml)
 ![Chrome Support](https://img.shields.io/badge/Chrome-Latest%20version-%234285F4?logo=google-chrome)
 ![Firefox Support](https://img.shields.io/badge/Firefox-Latest%20version-%23FF7139?logo=firefox-browser)
 ![Safari Support](https://img.shields.io/badge/Safari-Latest%20version-%23000000?logo=safari)
@@ -9,9 +9,7 @@
 
 ## Overview
 
-🚧 This project is still a work-in-progress! 🚧
-
-pojde Next Generation is a distributed multi-tenant development environment with web access to all components.
+pojde is a distributed multi-tenant development environment with web access to all components.
 
 It strives to be ...
 
@@ -21,45 +19,45 @@ It strives to be ...
 - **Portable:** Runs on both Intel/AMD and ARM and requires Docker as the only dependency
 - **Lean**: Built on projects like [code-server](https://github.com/cdr/code-server) and [JupyterLab](http://jupyterlab.io/)
 
-With pojde Next Generation, you can **develop from any device with a browser!**
+With pojde, you can **develop from any device with a browser!**
 
 ## Installation
 
-To install `pojdectl-ng`, the management tool for pojde Next Generation, paste the following into your terminal:
+To install `pojdectl`, the management tool for pojde, paste the following into your terminal:
 
 ```shell
-curl https://raw.githubusercontent.com/pojntfx/pojde-ng/main/bin/pojdectl-ng | bash -s -- upgrade-pojdectl-ng
+curl https://raw.githubusercontent.com/pojntfx/pojde/main/bin/pojdectl | bash -s -- upgrade-pojdectl
 ```
 
 Works on Linux, macOS and Windows (WSL2).
 
 ## Usage
 
-pojde Next Generation supports running many isolated instances on a host, where the host can be your local machine, a cloud server or even a Raspberry Pi. Before you continue to the next step, please [install Docker](https://docs.docker.com/get-docker/) on the host that you wish to run the instance on.
+pojde supports running many isolated instances on a host, where the host can be your local machine, a cloud server or even a Raspberry Pi. Before you continue to the next step, please [install Docker](https://docs.docker.com/get-docker/) on the host that you wish to run the instance on.
 
-To create your first instance, use `pojdectl-ng apply`:
+To create your first instance, use `pojdectl apply`:
 
 ```shell
-$ pojdectl-ng apply my-first-instance 5000 # Append `-n root@your-ip:ssh-port` to create the instance on a remote host instead
+$ pojdectl apply my-first-instance 5000 # Append `-n root@your-ip:ssh-port` to create the instance on a remote host instead
 ```
 
-Now follow the instructions. `pojdectl-ng apply` will ask you to download the CA certificate to your system, which you should do when creating the first instance; future instances will share this certificate. To trust the CA certificate, follow the videos we've created for you:
+Now follow the instructions. `pojdectl apply` will ask you to download the CA certificate to your system, which you should do when creating the first instance; future instances will share this certificate. To trust the CA certificate, follow the videos we've created for you:
 
 - [Trusting self-signed SSL certificates (Chrome on Linux)](https://www.youtube.com/watch?v=byFN8vH2SaM)
 - [Trusting self-signed SSL certificates (Chrome on macOS)](https://www.youtube.com/watch?v=_PJc7RcMnw8)
 - [Trusting self signed SSL certificates (Chrome on Windows)](https://www.youtube.com/watch?v=gyQ9IIxE3vc)
 
 Note that you'll have to **select the CA certificate you've downloaded in the step before**, not download the certificate as described in the videos.
 
-Once you've done so, list your instances with `pojdectl-ng list`:
+Once you've done so, list your instances with `pojdectl list`:
 
 ```shell
-$ pojdectl-ng list # Append `-n root@your-ip:ssh-port` to list the instances on a remote host instead
+$ pojdectl list # Append `-n root@your-ip:ssh-port` to list the instances on a remote host instead
 NAME                           STATUS     PORTS
 my-first-instance              running    5000-5005
 ```
 
-As you can see, our first instance (`my-first-instance`) is running and has exposed ports **5000** through **5005**. This port range has been selected when we ran `pojdectl-ng apply` above. You can now access the services (replace `localhost` with your remote host's IP or domain if you deployed to a remote host):
+As you can see, our first instance (`my-first-instance`) is running and has exposed ports **5000** through **5005**. This port range has been selected when we ran `pojdectl apply` above. You can now access the services (replace `localhost` with your remote host's IP or domain if you deployed to a remote host):
 
 | Icon                                                                                                                | Service                                           | Address                 | Description                            |
 | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------- | -------------------------------------- |
@@ -69,19 +67,19 @@ As you can see, our first instance (`my-first-instance`) is running and has expo
 | <img src="https://raw.githubusercontent.com/novnc/noVNC/master/app/images/icons/novnc-192x192.png" width="25">      | [noVNC](https://novnc.com/info.html)              | https://localhost:5003/ | Graphical access from the browser      |
 | <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/jupyter/jupyter-original.svg" width="25"> | [JupyterLab](http://jupyterlab.io/)               | https://localhost:5004/ | An interactive development environment |
 
-Additionally, there is a SSH server running on port `5005` which you can use to forward ports with `pojdectl-ng forward`:
+Additionally, there is a SSH server running on port `5005` which you can use to forward ports with `pojdectl forward`:
 
 ```shell
-$ pojdectl-ng forward my-first-instance 4200:1234 4201:1235 # Append `-n root@your-ip:ssh-port` to also forward from the remote host to the local host
+$ pojdectl forward my-first-instance 4200:1234 4201:1235 # Append `-n root@your-ip:ssh-port` to also forward from the remote host to the local host
 ```
 
 This, for example, forwards port `1234` in the instance to port `4200` on the local host and port `1235` to port `4201`.
 
-**🚀 That's it!** We hope you enjoy using pojde Next Generation.
+**🚀 That's it!** We hope you enjoy using pojde.
 
 ## Modules
 
-pojde Next Generation is based on a minimal base image; additional functionality can be added by enabling any of the following modules when running `pojdectl-ng apply`:
+pojde is based on a minimal base image; additional functionality can be added by enabling any of the following modules when running `pojdectl apply`:
 
 ## Language Modules
 
@@ -118,8 +116,8 @@ pojde Next Generation is based on a minimal base image; additional functionality
 ## Reference
 
 ```shell
-$ pojdectl-ng --help
-pojdectl-ng is the management tool for pojde Next Generation.
+$ pojdectl --help
+pojdectl is the management tool for pojde.
 Global Flags:
 [-n]ode <user@host:port>            Remote host to execute on.
                                     If not specified, execute locally.
@@ -151,14 +149,14 @@ enter <name>                        Get a shell in an instance.
 forward <name> [local:remote...]    Forward port(s) from an instance.
 
 Miscellaneous Commands:
-upgrade-pojdectl-ng                 Upgrade this tool.
+upgrade-pojdectl                 Upgrade this tool.
 reset-ca [-f]orce                   Reset the CA.
 
-For more information, please visit https://github.com/pojntfx/pojde-ng#Usage.
+For more information, please visit https://github.com/pojntfx/pojde#Usage.
 ```
 
 ## License
 
-pojde Next Generation (c) 2021 Felicitas Pojtinger and contributors
+pojde (c) 2021 Felicitas Pojtinger and contributors
 
 SPDX-License-Identifier: AGPL-3.0

bin/pojdectl-ng renamed to bin/pojdectl

@@ -1,15 +1,15 @@
 #!/bin/bash
 
 # Prefix for all objects in the Docker daemon.
-DOCKER_PREFIX=pojde-ng-
+DOCKER_PREFIX=pojde-
 # Name of the CA
 CA_VOLUME_NAME=${DOCKER_PREFIX}ca
 # Scripts to run to apply/refresh instances. Order matters. "parameters" is run before all others.
 SCRIPTS="user apt code-server ttyd novnc jupyter-lab nginx docker ssh git modules webwormhole clean"
 # Prefix to display before destructive operations.
 CONFIRMATION_PREFIX="This could lead to data loss. Really"
 
-# Shows pojdectl-ng usage information.
+# Shows pojdectl usage information.
 print_help() {
     case "$1" in
     "-h" | "--help")
@@ -20,7 +20,7 @@ print_help() {
         ;;
     esac
 
-    echo "pojdectl-ng is the management tool for pojde Next Generation.
+    echo "pojdectl is the management tool for pojde.
 Global Flags:
 [-n]ode <user@host:port>            Remote host to execute on.
                                     If not specified, execute locally.
@@ -52,17 +52,17 @@ enter <name>                        Get a shell in an instance.
 forward <name> [local:remote...]    Forward port(s) from an instance.
 
 Miscellaneous Commands:
-upgrade-pojdectl-ng                 Upgrade this tool.
+upgrade-pojdectl                 Upgrade this tool.
 reset-ca [-f]orce                   Reset the CA.
 
-For more information, please visit https://github.com/pojntfx/pojde-ng#Usage."
+For more information, please visit https://github.com/pojntfx/pojde#Usage."
 
     exit 0
 }
 
 # Asks the user to re-apply their instance.
 print_please_reapply() {
-    echo 'Please run "pojdectl-ng apply" again to re-initialize.'
+    echo 'Please run "pojdectl apply" again to re-initialize.'
 }
 
 # Gets a summary of the exposed ports for an instance.
@@ -127,10 +127,10 @@ if [ "${run_remotely}" = "true" ]; then
         exit 1
     fi
 
-    # Install pojdectl-ng if not already installed on remote host
-    is_already_installed=$(if [ -x "$(ssh -p ${port} ${host} command -v pojdectl-ng)" ]; then echo true; else echo false; fi)
+    # Install pojdectl if not already installed on remote host
+    is_already_installed=$(if [ -x "$(ssh -p ${port} ${host} command -v pojdectl)" ]; then echo true; else echo false; fi)
     if [ "${is_already_installed}" = "false" ]; then
-        scp -P ${port} $(which pojdectl-ng) ${host}:/usr/local/bin
+        scp -P ${port} $(which pojdectl) ${host}:/usr/local/bin
     fi
 
     # Strip the `-n` flag from the remote command
@@ -139,7 +139,7 @@ if [ "${run_remotely}" = "true" ]; then
     # The `forward` commadn requires advanced steps here
     if [ "$1" != "forward" ]; then
         # Run the command remotely
-        ssh -tt -p ${port} ${host} pojdectl-ng $remote_command
+        ssh -tt -p ${port} ${host} pojdectl $remote_command
 
         # Don't continue with local execution
         exit 0
@@ -210,11 +210,11 @@ apply)
     # Adjust Docker arguments if host system uses OpenRC
     docker_flags=""
     docker_args=""
-    docker_image="pojntfx/pojde-ng:latest"
+    docker_image="pojntfx/pojde:latest"
     if [ ! -n "$(which systemctl)" ]; then
-        docker_flags="-e POJDE_NG_OPENRC=true"
+        docker_flags="-e POJDE_OPENRC=true"
         docker_args="/sbin/openrc-init"
-        docker_image="pojntfx/pojde-ng:latest-openrc"
+        docker_image="pojntfx/pojde:latest-openrc"
     fi
 
     # Pull the latest image
@@ -250,8 +250,8 @@ apply)
             --tmpfs /run:exec \
             --tmpfs /run/lock:exec \
             -v /sys/fs/cgroup:/sys/fs/cgroup:ro \
-            -v ${DOCKER_PREFIX}${name}-preferences:/opt/pojde-ng/preferences:z \
-            -v ${CA_VOLUME_NAME}:/opt/pojde-ng/ca:z \
+            -v ${DOCKER_PREFIX}${name}-preferences:/opt/pojde/preferences:z \
+            -v ${CA_VOLUME_NAME}:/opt/pojde/ca:z \
             -v ${DOCKER_PREFIX}${name}-home-root:/root:z \
             -v ${DOCKER_PREFIX}${name}-home-user:/home:z \
             -v ${DOCKER_PREFIX}${name}-apt-cache:/var/cache/apt/archives:z \
@@ -266,7 +266,7 @@ apply)
     fi
 
     # Ask for parameters
-    docker exec -it ${docker_flags} ${DOCKER_PREFIX}${name} bash -c "/opt/pojde-ng/configuration/parameters.sh"
+    docker exec -it ${docker_flags} ${DOCKER_PREFIX}${name} bash -c "/opt/pojde/configuration/parameters.sh"
 
     # Exit if aborted
     if [ "$?" != "0" ]; then
@@ -277,7 +277,7 @@ apply)
 
     # Run the upgrade hooks of the scripts
     for script in $SCRIPTS; do
-        docker exec -it ${docker_flags} ${DOCKER_PREFIX}${name} bash -c ". /opt/pojde-ng/configuration/${script}.sh && upgrade"
+        docker exec -it ${docker_flags} ${DOCKER_PREFIX}${name} bash -c ". /opt/pojde/configuration/${script}.sh && upgrade"
     done
     ;;
 
@@ -362,7 +362,7 @@ remove)
             fi
             if [[ $REPLY =~ ^[Yy]$ ]]; then
                 for script in $SCRIPTS; do
-                    docker exec -it ${docker_flags} ${DOCKER_PREFIX}${name} bash -c ". /opt/pojde-ng/configuration/${script}.sh && refresh"
+                    docker exec -it ${docker_flags} ${DOCKER_PREFIX}${name} bash -c ". /opt/pojde/configuration/${script}.sh && refresh"
                 done
 
                 print_please_reapply
@@ -497,7 +497,7 @@ forward)
         done
 
         # Script to run remotely and locally
-        exec_line_remote="pojdectl-ng ${remote_command}"
+        exec_line_remote="pojdectl ${remote_command}"
         exec_line_local="ssh -f -p ${port} ${host} ${ports_to_forward}"
 
         # Forward from the container on the remote host to the remote host
@@ -561,11 +561,11 @@ forward)
     ;;
 
 # Upgrade this tool.
-upgrade-pojdectl-ng)
+upgrade-pojdectl)
     # Fetch the latest version from GitHub
-    sudo curl -L -o /usr/local/bin/pojdectl-ng https://raw.githubusercontent.com/pojntfx/pojde-ng/main/bin/pojdectl-ng
+    sudo curl -L -o /usr/local/bin/pojdectl https://raw.githubusercontent.com/pojntfx/pojde/main/bin/pojdectl
     # Make it executable
-    sudo chmod +x /usr/local/bin/pojdectl-ng
+    sudo chmod +x /usr/local/bin/pojdectl
     ;;
 
 # Reset the CA.
@@ -579,7 +579,7 @@ reset-ca)
     if [[ $REPLY =~ ^[Yy]$ ]]; then
         docker volume rm ${CA_VOLUME_NAME}
 
-        echo "Please run \"pojdectl-ng apply\" again for all instances to re-initialize; if you don't do so, you'll loose secure access to them."
+        echo "Please run \"pojdectl apply\" again for all instances to re-initialize; if you don't do so, you'll loose secure access to them."
     fi
     ;;
 

build/clean.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 # Remove configuration scripts
-rm -rf /opt/pojde-ng/configuration
+rm -rf /opt/pojde/configuration

build/cockpit.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Exit if not on systemd
-if [ "${POJDE_NG_OPENRC}" = 'true' ]; then exit 0; fi
+if [ "${POJDE_OPENRC}" = 'true' ]; then exit 0; fi
 
 # Install Cockpit
 apt install -y cockpit