chore: monorepo!

chore: monorepo!

Author: jgoux

README.md

@@ -1,42 +1,25 @@
+# :elephant: PostgreSQL, in your browser
 
-# pg-wasm
-
-Run [PostgreSQL](https://www.postgresql.org/) in the browser:
-
-![Screenshot 2022-08-29 at 14 58 13](https://user-images.githubusercontent.com/20510494/187206593-81811973-f2b2-45be-a5a2-d6c9cc57d973.png)
-
-# Getting started
+## :zap: Getting started
 
 ```bash
-npx serve
-   ┌────────────────────────────────────────────────────┐
-   │                                                    │
-   │   Serving!                                         │
-   │                                                    │
-   │   - Local:            http://localhost:3000        │
-   │   - On Your Network:  http://172.17.184.115:3000   │
-   │                                                    │
-   │   Copied local address to clipboard!               │
-   │                                                    │
-   └────────────────────────────────────────────────────┘
+cd pg-wasm && npx serve
 ```
 
-Tada! You should see a working psql terminal
-
-# Boot and save a new snapshot
+Go to http://localhost:3000 and have fun!
 
-1. Place the `filesystem` folder produced by https://github.com/jgoux/pg-browser in the root of the repository
+## :brain: Architecture
 
-2. Search in the `filesystem/filesystem.json` file for the `bzImage` corresponding `.bin` filename and replace its value in [index.html](index.html#L39)
+> TODO
 
-2. Go the `http://localhost:3000?boot=true`
+## :eyes: Going further
 
-3. Once the boot is completed, clear the cache running `echo 3 > /proc/sys/vm/drop_caches && reset` and click the "Save state to file" button
+- [pg-wasm](/packages/pg-wasm/README.md)
+- [Buildroot](/packages/buildroot/README.md)
 
-4. Put the state file into the `state/` folder and compress it:
-
-```bash
-zstd --ultra -22 state/state.bin && rm state/state.bin
-```
+## :clap: Aknowledgements
 
-5. Go to `http://localhost:3000`, the boot should be instant :rocket:
+- [v86](https://github.com/copy/v86) which is **the** emulator for running x86 operating systems in the browser, without it none of the following projects would be possible
+- [crunchydata playground](https://www.crunchydata.com/developers/playground) for leading the way and showing the world that it was possible to run PostgreSQL in the browser
+- [browser-shell](https://github.com/humphd/browser-shell) which was already way ahead of its time, especially on the filesystem part
+- [browser-linux](https://github.com/Darin755/browser-linux) for showing us how we can make the pieces fit together

filesystem/filesystem.json

@@ -0,0 +1,4 @@
+dist/*
+.gitignore
+LICENSE
+README.md

packages/buildroot/.dockerignore

@@ -0,0 +1 @@
+build

packages/buildroot/.gitignore

@@ -0,0 +1,52 @@
+FROM rastasheep/ubuntu-sshd:18.04
+
+# Buildroot version to use
+ARG BUILD_ROOT_RELEASE=2022.08-rc1
+
+# Root password for SSH
+ARG ROOT_PASSWORD=browser-vm
+
+# Setup SSH (for Windows users) and prepare apt-get
+RUN echo 'root:${ROOT_PASSWORD}' | chpasswd; \
+    # Install all Buildroot deps
+    sed -i 's|deb http://us.archive.ubuntu.com/ubuntu/|deb mirror://mirrors.ubuntu.com/mirrors.txt|g' /etc/apt/sources.list; \
+    dpkg --add-architecture i386; \
+    rm -rf /var/lib/apt/lists/*; \
+    apt-get -q update;
+
+# Install all Buildroot deps and prepare buildroot
+WORKDIR /root
+
+RUN DEBIAN_FRONTEND=noninteractive apt-get -q -y install \
+    bc \
+    build-essential \
+    bzr \
+    cpio \
+    cvs \
+    git \
+    unzip \
+    wget \
+    libc6:i386 \
+    libncurses5-dev \
+    libssl-dev \
+    rsync; \
+    wget -c http://buildroot.org/downloads/buildroot-${BUILD_ROOT_RELEASE}.tar.gz; \
+    tar axf buildroot-${BUILD_ROOT_RELEASE}.tar.gz;
+
+# configure the locales
+ENV LANG='C' \
+    LANGUAGE='en_US:en' \
+    LC_ALL='C' \
+    NOTVISIBLE="in users profile" \
+    TERM=xterm
+
+# Buildroot will place built artifacts here at the end.
+VOLUME /build
+
+WORKDIR /root/buildroot-${BUILD_ROOT_RELEASE}
+
+COPY config /config
+
+RUN cp -r /config/* /config/.config .
+
+ENTRYPOINT ["bash"]

packages/buildroot/Dockerfile

@@ -0,0 +1,53 @@
+# Buildroot
+
+> Buildroot configuration to build a v86 compatible minimal Linux system containing PostgreSQL
+
+## Getting started
+
+The goal of this build process is to produce a `filesystem` folder containing a full Linux filesystem that will be mounted and served by v86
+
+1. Build and run the container to execute Buildroot
+
+```bash
+./build.sh
+```
+
+  1.1. If you need to refresh the Buildroot configuration files from the host, execute this command [OPTIONAL]:
+
+  ```bash
+  cp -r /config/* /config/.config .
+  ```
+
+  1.2. Tweak the configuration and save it back to the host [OPTIONAL]:
+
+  ```bash
+  # Linux system config
+  # Launch menuconfig
+  make menuconfig
+  # Save the changes back to the host
+  cp .config /pg-wasm/.config
+
+  # Linux kernel config
+  # IMPORTANT: If it's the first time you run this command,
+  # exit the linux-menuconfig when it opens and copy the host file by running
+  # cp /pg-wasm/board/pg-wasm/linux.conf ./output/build/linux-5.17.15/.config
+  # then you can go back to "make linux-menuconfig" to edit this configuration
+  # Launch menuconfig
+  make linux-menuconfig
+  # Save the changes back to the host
+  cp output/build/linux-5.17.15/.config /pg-wasm/board/pg-wasm/linux.conf
+  ```
+
+2. Build the `filesystem` folder:
+
+```bash
+make
+```
+
+...
+
+At this point you can go for a walk, it will take a bit of time :turtle:
+
+...
+
+The `filesystem` folder should be available on the host at `build/filesystem`

packages/buildroot/README.md

@@ -0,0 +1,10 @@
+docker build -t buildroot .
+
+docker run \
+    --rm \
+    -v $PWD/tools:/tools \
+    -v $PWD/build:/build \
+    -v $PWD/config/config \
+    -ti \
+    --platform linux/amd64 \
+    buildroot