No commit message

.github/workflows/docker-community.yml

@@ -29,8 +29,8 @@ jobs:
         
       - name: Generate info.json
         run: |
-          if [[ -f deploy/enterprise/scripts/generate_info_json.sh ]]; then
-            deploy/enterprise/scripts/generate_info_json.sh
+          if [[ -f deploy/community/scripts/generate_info_json.sh ]]; then
+            deploy/community/scripts/generate_info_json.sh
           fi
 
       - uses: docker/setup-qemu-action@v1
@@ -71,15 +71,15 @@ jobs:
       - name: Replace Version ~2.6 to Tag
         uses: jacobtomlinson/gha-find-replace@v2
         with:
-          include: deploy/docker/app/platform/package.json
+          include: deploy/community/app/platform/package.json
           find: "~2.6"
           replace: ${{env.STEEDOS_VERSION}}
           regex: false
 
       - name: Build and push docker
         uses: docker/build-push-action@v3
         with:
-          context: ./deploy/docker
+          context: ./deploy/community
           platforms: linux/amd64 #,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}

deploy/community/Dockerfile

@@ -0,0 +1,145 @@
+FROM ubuntu:focal
+
+# The env variables are needed for Steedos server to correctly handle non-roman scripts like Arabic.
+ENV LANG C.UTF-8
+ENV LC_ALL C.UTF-8
+ARG DEBIAN_FRONTEND=noninteractive
+ENV TZ=Etc/UTC
+
+RUN apt-get update || : && apt-get install -y \
+    python \
+    curl \
+    build-essential 
+
+RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - 
+
+RUN apt-get update \
+    && apt-get install -y gnupg curl nodejs
+
+# Install MongoDB 4.4.25
+# https://www.mongodb.com/docs/v4.4/tutorial/install-mongodb-on-ubuntu/
+# https://github.com/docker-library/mongo/blob/66197d92be6eafc0a36b2570172de0a5f7a905e1/4.4/Dockerfile
+RUN set -ex; \
+	export GNUPGHOME="$(mktemp -d)"; \
+	set -- '20691EEC35216C63CAF66CE1656408E390CFB1F5'; \
+	for key; do \
+		gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key"; \
+	done; \
+	mkdir -p /etc/apt/keyrings; \
+	gpg --batch --export "$@" > /etc/apt/keyrings/mongodb.gpg; \
+	gpgconf --kill all; \
+	rm -rf "$GNUPGHOME"
+
+# Allow build-time overrides (eg. to build image with MongoDB Enterprise version)
+# Options for MONGO_PACKAGE: mongodb-org OR mongodb-enterprise
+# Options for MONGO_REPO: repo.mongodb.org OR repo.mongodb.com
+# Example: docker build --build-arg MONGO_PACKAGE=mongodb-enterprise --build-arg MONGO_REPO=repo.mongodb.com .
+ARG MONGO_PACKAGE=mongodb-org
+ARG MONGO_REPO=repo.mongodb.org
+ENV MONGO_PACKAGE=${MONGO_PACKAGE} MONGO_REPO=${MONGO_REPO}
+
+ENV MONGO_MAJOR 4.4
+RUN echo "deb [ signed-by=/etc/apt/keyrings/mongodb.gpg ] http://$MONGO_REPO/apt/ubuntu focal/${MONGO_PACKAGE%-unstable}/$MONGO_MAJOR multiverse" | tee "/etc/apt/sources.list.d/${MONGO_PACKAGE%-unstable}.list"
+
+# https://docs.mongodb.org/master/release-notes/4.4/
+ENV MONGO_VERSION 4.4.25
+# 09/26/2023, https://github.com/mongodb/mongo/tree/3e18c4c56048ddf22a6872edc111b542521ad1d5
+
+RUN set -x \
+# installing "mongodb-enterprise" pulls in "tzdata" which prompts for input
+	&& export DEBIAN_FRONTEND=noninteractive \
+	&& apt-get update \
+	&& apt-get install -y \
+		${MONGO_PACKAGE}=$MONGO_VERSION \
+		${MONGO_PACKAGE}-server=$MONGO_VERSION \
+		${MONGO_PACKAGE}-shell=$MONGO_VERSION \
+		${MONGO_PACKAGE}-mongos=$MONGO_VERSION \
+		${MONGO_PACKAGE}-tools=$MONGO_VERSION \
+	&& rm -rf /var/lib/apt/lists/* \
+	&& rm -rf /var/lib/mongodb \
+	&& mv /etc/mongod.conf /etc/mongod.conf.orig
+
+# Install nginx && redis
+RUN apt-get update \
+    && apt-get install -y nginx nginx-extras redis-server \
+    && apt-get install -y cron supervisor git python3-pip python3-venv git ca-certificates\
+    && pip3 install --no-cache-dir git+https://github.com/coderanger/supervisor-stdout@973ba19967cdaf46d9c1634d1675fc65b9574f6e \
+    # && pip3 install supervisor-stdout \
+    && python3 -m venv --prompt certbot /opt/certbot/venv \
+    && /opt/certbot/venv/bin/pip install --upgrade certbot setuptools pip \
+    && ln -s /opt/certbot/venv/bin/certbot /usr/local/bin \
+    && apt-get remove -y git python3-pip python3-venv \
+    && apt-get clean -y
+
+# yarn 
+
+RUN npm install --global yarn
+
+# platform
+COPY ./app/platform /app
+
+ENV NODE_ENV=production
+
+WORKDIR /app
+
+RUN yarn && yarn cache clean
+
+# steedosctl
+COPY ./app/steedosctl /opt/steedos/steedosctl
+
+WORKDIR /opt/steedos/steedosctl
+
+RUN npm install --only=prod && npm install --only=prod -g
+
+# unpkg
+COPY ./app/unpkg /opt/steedos/unpkg
+WORKDIR /opt/steedos/unpkg
+
+RUN npm i --production  && npm cache clean --force
+
+COPY ./fs /
+
+# Remove cached files
+RUN rm -rf \
+  /root/.cache \
+  /root/.npm \
+  /root/.pip \
+  /usr/local/share/doc \
+  /usr/share/doc \
+  /usr/share/man \
+  /var/lib/apt/lists/* \
+  /tmp/*
+
+
+# Set workdir to /opt/steedos
+WORKDIR /opt/steedos
+
+# ------------------------------------------------------------------------
+ENV TMP /tmp/steedos
+ENV NGINX_WWW_PATH="$TMP/www"
+
+RUN cd - \
+  && chmod 0644 /etc/cron.d/* \
+  && chmod +x entrypoint.sh renew-certificate.sh healthcheck.sh templates/nginx-app.conf.sh /watchtower-hooks/*.sh \
+  # Disable setuid/setgid bits for the files inside container.
+  && find / \( -path /proc -prune \) -o \( \( -perm -2000 -o -perm -4000 \) -print -exec chmod -s '{}' + \) || true  \
+  && node prepare-image.mjs
+
+
+ENV PATH /opt/steedos/utils/node_modules/.bin:/opt/java/bin:$PATH
+
+LABEL com.centurylinklabs.watchtower.lifecycle.pre-check=/watchtower-hooks/pre-check.sh
+LABEL com.centurylinklabs.watchtower.lifecycle.pre-update=/watchtower-hooks/pre-update.sh
+
+# ENV defaults
+ENV ROOT_URL=http://127.0.0.1:3000 \
+    NODE_ENV=production 
+
+# Define volumes - Service Layer
+VOLUME [ "/steedos-storage" ]
+
+ENTRYPOINT [ "/opt/steedos/entrypoint.sh" ]
+
+HEALTHCHECK --interval=15s --timeout=15s --start-period=45s CMD "/opt/steedos/healthcheck.sh"
+
+CMD ["/usr/bin/supervisord", "-n"]

deploy/community/README.md

@@ -0,0 +1,189 @@
+# Steedos Platform Docker Image
+
+The Steedos Platform Docker image is built with all the components required for it to run, within a single Docker container. Files in this directory make up for the scripts and template files needed for building the image.
+
+## Self Host
+
+The following subsections describe how you can get started with _your own_ instance of Steedos Platform.
+
+### 1. Prerequisites
+
+Ensure `docker` and `docker-compose` are installed and available for starting containers:
+
+- Install Docker: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
+- Install Docker Compose: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
+
+You may verify the installation by running `docker --version` and `docker-compose --version`. The output should roughly be something like below:
+
+```sh
+$ docker --version
+Docker version 20.10.7, build f0df350
+$ docker-compose --version
+docker-compose version 1.29.2, build 5becea4c
+```
+
+### 2. Docker compose configuration
+
+Create a folder called `steedos` (or some other name that you like), which will serve as our installation folder. Inside this folder, create a `docker-compose.yml` file and copy the following content into it:
+
+```yaml
+version: "3"
+
+services:
+  steedos:
+    image: steedos/steedos-community
+    container_name: steedos-community
+    ports:
+      - "80:80"
+      - "443:443"
+      - "9001:9001"
+    volumes:
+      - ./storage:/steedos-storage
+    restart: unless-stopped
+  #   # Uncomment the lines below to enable auto-update
+  #   labels:
+  #     com.centurylinklabs.watchtower.enable: "true"
+
+  # auto_update:
+  #   image: containrrr/watchtower
+  #   volumes:
+  #     - /var/run/docker.sock:/var/run/docker.sock
+  #   # Update check interval in seconds.
+  #   command: --schedule "0 0 * ? * *" --label-enable --cleanup
+  #   restart: unless-stopped
+
+
+```
+>>Note: To enable auto-update for Steedos Platform, please uncomment all the commented lines in the docker-compose file.
+
+After saving this file, `cd` to the folder that contains this file and run the following command to start Steedos Platform:
+
+```sh
+docker-compose up -d
+```
+
+This command may take a few minutes to download the docker image and initialize the application. Steedos Platform should soon be available at <http://localhost>.
+
+You can check if application is running correctly by running `docker ps` or `docker-compose ps` (running `docker-compose` will require you to be in the directory containing the `docker-compose.yml` file to work).
+
+```sh
+$ docker ps
+CONTAINER ID        IMAGE                             COMMAND                  CREATED             STATUS              PORTS                                      NAMES
+3b8f2c9638d0        steedos/steedos-community        "/opt/steedos/entrypoint.sh"   17 minutes ago      Up 17 minutes       0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp   Steedos
+```
+
+You can also use the Supervisord UI to monitor and manage the different processes _inside_ the container. This is discussed [further below](#supervisord).
+
+## Custom Domain
+
+To make Steedos Platform available on a custom domain, please update your domain's DNS records to point to the instance running Steedos Platform. Most domain registrars / DNS-providers have documentation on how you can do this yourself.
+
+* [GoDaddy](https://in.godaddy.com/help/create-a-subdomain-4080)
+* [Amazon Route 53](https://aws.amazon.com/premiumsupport/knowledge-center/create-subdomain-route-53/)
+* [Digital Ocean](https://www.digitalocean.com/docs/networking/dns/how-to/add-subdomain/)
+* [NameCheap](https://www.namecheap.com/support/knowledgebase/article.aspx/9776/2237/how-to-create-a-subdomain-for-my-domain)
+* [Domain.com](https://www.domain.com/help/article/domain-management-how-to-update-subdomains)
+
+## Custom SSL Certificate
+
+In our container, we support to generate a free SSL certificate If you have your owned certificate, please follow these steps to use it inside the container.
+- Firstly, please rename your certificate file as `fullchain.pem` and key file as `privkey.pem` 
+- Then, copy these files into the sub-directory `<mounting-directory>/ssl/` (*Note: Please change `<mounting-directory>` by the mounting volume directory in the `docker-compose.yml`. Default is `./storage`*)
+- Restart the container using `docker restart Steedos Platform`
+
+The container will check the certificate files in the folder `<mounting-directory>/ssl` and use them if they are existed.
+
+*Note: In case of the certificate files have different name from `fullchain.pem` and `privkey.pem`, it will be considered as missing custom certificate and auto-provisioning the certificate by Let's Encrypt*
+## Instance Management Utilities
+
+The image includes an `steedosctl` command to help with the management and maintenance of your instance. The following subsections describe what's available.
+
+### Export database
+
+The following command can be used to take a backup dump of Steedos Platform's database. This can be restored onto another instance using the import command (discussed below) to restore all data.
+
+Before running this, ensure you are in the directory where `docker-compose.yml` is located.
+
+```sh
+docker-compose exec steedos-community steedosctl export_db
+```
+
+The output file will be stored in the container directory `/steedos-storage/data/backup/steedos-data.archive`. Thanks to the volume configuration in the `docker-compose.yml` file, it should be available on your host machine at `./storage/data/backup/steedos-data.archive`.
+
+If your volume configuration is different or unavailable, you can use the following command to copy the archive file to your host disk:
+
+```sh
+docker-compose cp steedos-community:/steedos-storage/data/backup/steedos-data.archive .
+```
+
+Note that you may want to save the `docker.env` file in addition to this archive file, if you intend to be able to reproduce this environment elsewhere, or in case of a disaster. This file can be copied out of the container with the following command:
+
+```sh
+docker-compose cp steedos-community:/steedos-storage/configuration/docker.env .
+```
+
+**Be sure to keep this file safe**, since it contains information that can be used to decrypt datasource information from the database archive.
+
+### Import database
+
+The following command can restore backup archive, that was produced by the export command (discussed above).
+
+First, copy the archive file into the container using the following command:
+
+```sh
+docker-compose cp ./steedos-data.archive steedos-community:/steedos-storage/data/restore/
+```
+
+Second, run the following command to import data from this file:
+
+```sh
+docker-compose exec steedos-community steedosctl import_db
+```
+
+Note that when you restore, you may also want to copy a `docker.env` from the original instance into this one. You can use the following command to do this (assuming you are in the installation folder and `docker.env` exists in the same folder):
+
+```sh
+docker-compose cp ./docker.env steedos-community:/steedos-storage/configuration/
+```
+
+This will need a restart of the Steedos Platform server, which can be done using the following command:
+
+```sh
+docker-compose exec steedos-community supervisorctl restart backend
+```
+
+### Migrate To New Server
+
+To migrate a running container to a new server or other machine, you can use the following `migrate` command and replace the `<user>` and `<new-server-ip-address>` by the user and IP address of the destination server or machine.
+```
+docker exec steedos-community steedosctl migrate <user>@<new-server-ip-address>
+```
+This command will migrate all data and configuration of running container on source machine to destination machine and start a new container on destination machine.
+
+## Supervisor
+
+The container runs multiple processes, including the Steedos Platform server, Nginx, MongoDB etc., inside a single Docker container. These processes are started and managed by [supervisord](http://supervisord.org/).
+
+Supervisord comes with a web interface for managing the various processes, available at <http://localhost/supervisor/>, as well as a command line interface towards the same goal.
+
+The command line interface can also be used to perform operations like restarting the Steedos Platform server, or restarting Nginx etc. For example, the following command (run in the installation folder) can be used to get a status of all running processes:
+
+```sh
+docker-compose exec steedos-community supervisorctl status
+```
+
+Or to view the last few lines of stderr output of one of the processes:
+
+```sh
+docker-compose exec steedos-community supervisorctl tail backend stderr
+```
+
+To learn more, please refer to [Supervisor's documentation](http://supervisord.org/running.html#supervisorctl-actions) on what actions are available to be performed by the command line interface.
+
+## Troubleshooting
+
+If you encounter any errors during this process, please reach out to [**[email protected]**](mailto:[email protected]) or join our [Discord Server](https://discord.gg/84BFNFQP) and reach out on the #support channel.
+
+## Special Thanks
+
+- [Appsmith](https://github.com/appsmithorg/appsmith)

deploy/community/app/platform/package.json

@@ -0,0 +1,14 @@
+{
+    "name": "steedos-community",
+    "private": true,
+    "scripts": {
+      "start": "steedos start"
+    },
+    "dependencies": {
+      "@steedos/service-community": "~2.6"
+    },
+    "resolutions": {
+      "@azure/core-rest-pipeline": "1.12.1",
+      "@azure/core-util": "1.5.0"
+    }
+  }