get ready for release

Author: mrfrase3

README.md

@@ -1,4 +1,30 @@
 # duino.app Docker Compile Server
 ## aka Chromeduino 3.0
 
-# Notice: This is a work in progress and may not currently work.
+This server acts as an interface between the duino.app client and the arduino-cli.
+
+The main purpose of this is to let arduino-cli handle most of the code compiling work.
+
+The main update made in 3.0 is the websocket interface, which gives real-time communication with
+the client, allowing us to proxy the serial connection to the device for uploading.
+
+It's important to note that this server is bundled using docker with **All** the libraries installed,
+this allows anyone to use any library they desire by simply including it. The down side of this is
+that the servers docker-bundle size is several gigabytes in size.
+
+## Installing a local compile server
+
+**Warning:** The server download is serveral gigabytes in size, initial installation will take a while.
+
+1. Make sure [docker is installed.](https://docs.docker.com/engine/install/)
+2. run `docker run -p 3030:3030 --restart always -d duinoapp/duinoapp-server:latest`
+
+The compile server will be available at `http://localhost:3030`
+
+## Making a server accessable remotely
+
+If you've installed this on an existing server, just setup a reverse proxy to `http://localhost:3030`.
+
+Alternatively, you can setup this on a fresh server by following [these instructions.](link)
+
+If you have no clue what I'm talking about, reachout for help.

base-all/data/.dockerignore

@@ -0,0 +1 @@
+arduino/

base-all/data/Dockerfile

@@ -4,7 +4,7 @@ USER root
 RUN useradd duino
 
 COPY setup /home/duino/setup
-COPY data /home/duino/data
+# COPY data /home/duino/data
 # COPY Arduino /home/duino/Arduino
 
 RUN chown duino:duino /home/duino -R
@@ -13,8 +13,9 @@ RUN apt-get update && apt-get install build-essential
 WORKDIR /home/duino
 USER duino
 
-RUN wget https://github.com/arduino/arduino-cli/releases/download/0.9.0/arduino-cli_0.9.0_Linux_64bit.tar.gz -O - | tar -xz
+RUN wget https://github.com/arduino/arduino-cli/releases/download/0.13.0/arduino-cli_0.13.0_Linux_64bit.tar.gz -O - | tar -xz
 
+RUN mkdir data
 RUN ls
 
 ENV CLI_ARGS="--config-file /home/duino/data/arduino-cli.yml --format json"

deployment/README.md

@@ -0,0 +1,22 @@
+# Remote deployment
+
+Theses are some files to help make deploying on a remote server easier.
+This assumes a fresh VPS with Ubuntu 20 +, that is only going to be used as
+a compile server. A minimum of 20GB of storage is required.
+
+VPS = Virtual Private Server
+
+1. Create the VPS, Digital Ocean droplets are usually good for beginners (cheapest will do)
+2. Point your subdomain to the VPS (this will be an A record with the VPS's public IP)
+3. SSH into the VPS, you can usually do this from the Digital Ocean web interface.
+4. Run the command `<insert command here>` (This will take a while)
+5. Run the command `nano docker-compose.yml`
+6. Edit the content of the file where indicated, you should enter details like the domain, subdomain, email, server info
+7. When done editing, press `Ctl+X`, `Y`, and then `Enter`
+8. Run `docker-compose up -d`
+
+The server should now be available on your subdomain.
+
+## I Have No Clue What You Just Said
+
+That's ok. Feel free to reach out. If you want to add a new public compile server, we can help you with everything.

deployment/default

@@ -0,0 +1,45 @@
+## duinoapp proxy config
+
+# redirect all traffic to https
+server {
+	listen 80 default_server;
+	listen [::]:80 default_server;
+	server_name _;
+	return 301 https://$host$request_uri;
+}
+
+# main server block
+server {
+	listen 443 ssl http2 default_server;
+	listen [::]:443 ssl http2 default_server;
+
+	server_name _;
+
+	# enable subfolder method reverse proxy confs
+	include /config/nginx/proxy-confs/*.subfolder.conf;
+
+	# all ssl related config moved to ssl.conf
+	include /config/nginx/ssl.conf;
+
+	client_max_body_size 0;
+
+	location / {
+		proxy_set_header Host $host;
+		proxy_set_header X-Real-IP $remote_addr;
+		proxy_pass http://duinoapp:3030;
+		proxy_set_header X-Forwarded-Proto $scheme;
+		proxy_http_version 1.1;
+		proxy_set_header Upgrade $http_upgrade;
+		proxy_set_header Connection "upgrade";
+		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+		proxy_read_timeout 3m;
+		proxy_send_timeout 3m;
+	}
+
+}
+
+
+# enable subdomain method reverse proxy confs
+include /config/nginx/proxy-confs/*.subdomain.conf;
+# enable proxy cache for auth
+proxy_cache_path cache/ keys_zone=auth_cache:10m;

deployment/docker-compose.yml

@@ -0,0 +1,33 @@
+version: "2.1"
+services:
+  swag:
+    image: linuxserver/swag
+    container_name: swag
+    cap_add:
+      - NET_ADMIN
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - URL=duino.app # update this, main domain
+      - SUBDOMAINS=au # update this, subdomain of compile server
+      - VALIDATION=http
+      - [email protected] # update this, contact email for letsencrypt incase something goes wrong
+      - ONLY_SUBDOMAINS=true # update this, only encypt subdomains (au.duino.app)
+    volumes:
+      - /home/ubuntu/nginx:/config # update this, location on main server for nginx configs
+    ports:
+      - 443:443
+      - 80:80
+    restart: unless-stopped
+    links:
+      - duinoapp
+  duinoapp:
+    image: duinoapp/duinoapp-server:latest
+    container_name: duinoapp
+    environment: # update these, server info displayed to users
+      - SERVER_INFO_NAME="Australian Server"
+      - SERVER_INFO_LOCATION="Australia/Sydney"
+      - SERVER_INFO_COUNTRY="AU"
+      - SERVER_INFO_OWNER="Duino App"
+      - SERVER_INFO_WEBSITE="duino.app"
+      - SERVER_INFO_DESCRIPTION="Server run on Vegemite"

deployment/init-server.sh

@@ -0,0 +1,15 @@
+curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+
+sudo add-apt-repository \
+   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
+   $(lsb_release -cs) \
+   stable"
+
+sudo apt-get update
+sudo apt-get upgrade -y
+sudo apt-get install -y docker-ce docker-ce-cli containerd.io
+sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+sudo chmod +x /usr/local/bin/docker-compose
+
+sudo docker pull duinoapp/duinoapp-server:latest
+

src/actions/program.js

@@ -9,20 +9,30 @@ const program = {
   randId: () => Math.random().toString(16).substr(2),
 
   getError: (res) => {
-    let obj;
+    let error;
     try {
-      obj = JSON.parse(res.split('\n').pop());
+      error = JSON.parse(res.split('\n').pop());
     } catch (err) {
-      return null;
+      return {};
     }
-    if (obj && obj.Cause) return obj;
-    return null;
+    if (error && error.Cause) return { error };
+    return {};
   },
 
-  compile: async ({ fqbn, files }, socket, done) => {
+  compile: async ({ fqbn, files, noHex = false }, socket, done) => {
     await tmpFiles.loadTempFiles(files, socket);
-    const res = await cli('compile', ['-v', '--warnings', 'all', '--fqbn', fqbn, socket.sketchPath], socket);
+    const res = await cli('compile', [
+      '-v',
+      '--warnings', 'all',
+      '--fqbn', fqbn,
+      ...(!noHex ? ['--output', `${socket.sketchPath}/output`] : []),
+      socket.sketchPath,
+    ], socket);
     const response = program.getError(res);
+    if (!response.error && !noHex) {
+      const hex = await fs.readFile(`${socket.sketchPath}/output.hex`, 'base64');
+      response.hex = hex;
+    }
     // tmpFiles.cleanup(socket);
     if (done) done(response);
     return response;
@@ -72,12 +82,12 @@ const program = {
       `${session.sketchPath}/legacy`,
       session.sketchPath,
     ]);
-    const err = program.getError(res);
-    if (err) {
+    const response = program.getError(res);
+    if (response.error) {
       return {
         success: false,
-        msg: err.Cause,
-        code: err.Code,
+        msg: response.error.Cause,
+        code: response.error.Code,
         stdout: '',
         stderr: res,
       };