Merge Release Auto-PR

.commit

@@ -0,0 +1,6 @@
+# === FOR EMPTY COMMITS ===
+# Select reason for empty commit:
+- [ ] Add conventional commit message for changelog
+- [x] Forgot to use conventional commit style
+# Increment this value if nothing above was changed
+0

.env.example

@@ -1 +1 @@
-PORT=4000
+PORT=4000

.github/workflows/build-and-test.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x, 21.x]
+        node-version: [20.x, 21.x, 22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

.github/workflows/docker-image.yaml

@@ -5,8 +5,10 @@ name: Docker Image CI
 # branch called `main`.
 on:
   push:
-    branches: ['release']
-
+    tags:
+      - '*.*.*'
+    branches:
+      - 'main'
 
 # Defines two custom environment variables for the workflow. These are used
 # for the Container registry domain, and a name for the Docker image that
@@ -40,12 +42,12 @@ jobs:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-          
-      - name: Set up QEMU 
+
+      - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about)
       # to extract tags and labels that will be applied to the specified image.
@@ -56,16 +58,10 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          images: "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}"
           tags: |
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
             type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
-            type=sha
-            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+            type=ref,event=branch
 
       # This step uses the `docker/build-push-action` action to build the
       # image, based on your repository's `Dockerfile`. If the build succeeds,
@@ -81,6 +77,8 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           context: .
-          push: true
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

@@ -1,12 +1,28 @@
+# Misc
 .DS_Store
+
+# Dependencies
 node_modules/
+
 *.zip
 *.tgz
 license.config.json
 license-header.txt
+
+# Build Outputs
 dist/
-.vscode/
+
+# VS Code IDE
+.vscode/**/*
+!.vscode/extensions.json
+!.vscode/launch.json
+!.vscode/settings.json
+!.vscode/tasks.json
+
+# Local env files
 .env
+!.env.example
+
 # this is for jetbrain IDEs
 .idea/
 /puter

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "dnsmasq",
+        "heyputer",
+        "Puter"
+    ]
+}

Dockerfile

@@ -28,7 +28,7 @@ RUN npm cache clean --force \
     && npm ci
 
 # Run the build command if necessary
-RUN npm run build
+RUN cd src/gui && npm run build && cd -
 
 # Production stage
 FROM node:21-alpine
@@ -46,7 +46,7 @@ RUN mkdir -p /opt/puter/app
 WORKDIR /opt/puter/app
 
 # Copy built artifacts and necessary files from the build stage
-COPY --from=build /app/dist ./dist
+COPY --from=build /app/src/gui/dist ./dist
 COPY --from=build /app/node_modules ./node_modules
 COPY . .
 

README.md

@@ -19,27 +19,31 @@
     <a href="https://hackerone.com/puter_h1b">Bug Bounty</a>
 </p>
 
-<h3 align="center"><img width="700" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-2.webp"></h3>
+<h3 align="center"><img width="700" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-3.webp"></h3>
 
 <br/>
 
 ## Puter
 
-Puter is an advanced, open-source internet operating system designed to be feature-rich, exceptionally fast, and highly extensible. It can be used to build remote desktop environments or serve as an interface for cloud storage services, remote servers, web hosting platforms, and more.
+Puter is an advanced, open-source internet operating system designed to be feature-rich, exceptionally fast, and highly extensible. Puter can be used as:
+
+- A privacy-first personal cloud to keep all your files, apps, and games in one secure place, accessible from anywhere at any time.
+- A platform for building and publishing websites, web apps, and games.
+- An alternative to Dropbox, Google Drive, OneDrive, etc. with a fresh interface and powerful features.
+- A remote desktop environment for servers and workstations.
+- A friendly, open-source project and community to learn about web development, cloud computing, distributed systems, and much more!
 
 <br/>
 
 ## Getting Started
 
-After reading this section, please proceed to **Self-Hosting** and **Configuration** below.
-Read these instructions carefully or you may see errors due to
-an invalid setup.
 
-### Local Development
+### 💻 Local Development
 
 ```bash
 git clone https://github.com/HeyPuter/puter
 cd puter
+cp .env.example .env
 npm install
 npm start
 ```
@@ -48,109 +52,41 @@ This will launch Puter at http://localhost:4000 (or the next available port).
 
 <br/>
 
-### Using Docker
+### 🐳 Docker
 
-**note:** it is **not** necessary to run this within a clone of this repository. For contributors, it is recommended to use the [Local Development](#local-development) instructions.
 
 ```bash
 mkdir puter && cd puter && mkdir -p puter/config puter/data && sudo chown -R 1000:1000 puter && docker run --rm -p 4100:4100 -v `pwd`/puter/config:/etc/puter -v `pwd`/puter/data:/var/puter  ghcr.io/heyputer/puter
 ```
 
-### Using Docker Compose
+<br/>
+
+
+### 🐙 Docker Compose
 
-**note:** it is **not** necessary to run this within a clone of this repository. For contributors, it is recommended to use the [Local Development](#local-development) instructions.
 
 ```bash
 mkdir -p puter/config puter/data
 sudo chown -R 1000:1000 puter
 wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml
 docker compose up
 ```
-
 <br/>
 
-See [Configuration](#configuration) for next steps.
-
-<br/>
+### ☁️ Puter.com
 
-## ⚠️ Self-Hosting ⚠️
-The self-hosted version of Puter is currently in alpha stage and should not be used in production yet. It is under active development and may contain bugs, other issues. Please exercise caution and use it for testing and evaluation purposes only.
+Puter is available as a hosted service at [**puter.com**](https://puter.com).
 
 <br/>
 
-## Configuration
-
-Running the server will generate a configuration file in one of these locations:
-- `config/config.json` when [Using Docker](#using-docker)
-- `volatile/config/config.json` in [Local Development](#local-development)
-- `/etc/puter/config.json` on a server (or within a Docker container)
-
-### Domain Name
-
-To access Puter on your device, you can simply go to the address printed in
-the server console (usually `puter.localhost:4100`).
 
-To access Puter from another device, a domain name must be configured, as well as
-an `api` subdomain. For example, `example.local` might be the domain name pointing
-to the IP address of the server running puter, and `api.example.com` must point to
-this address as well. This domain must be specified in the configuration file
-(usually `volatile/config/config.json`) as well.
-
-See [domain configuration](./doc/self-hosters/domains.md) for more information.
-
-### Configure the Port
-
-- You can specify a custom port by setting `http_port` to a desired value
-- If you're using a reverse-proxy such as nginx or cloudflare, you should
-  also set `pub_port` to the public (external) port (usually `443`)
-- If you have HTTPS enabled on your reverse-proxy, ensure that
-  `protocol` in config.json is set accordingly
-
-### Default User
-
-By default, Puter will create a user called `default_user`.
-This user will have a randomly generated password, which will be printed
-in the development console.
-A warning will persist in the dev console until this user's
-password is changed. Please login to this user and change the password as
-your first step.
-
-<br/>
 
 ##  License
 
 This repository is licensed under AGPL-3.0; However, our SDK (puter.js) is also available under Apache 2.0, as indicated by the license file in that section (packages/puter-js) of this repository.
 
 <br/>
 
-## FAQ
-
-### ❓ What's the use case for Puter?
-
-Puter can be used as:
-
-- An alternative to Dropbox, Google Drive, OneDrive, etc. with a fresh interface and powerful features.
-- Remote desktop environment for servers and workstations.
-- A platform for building and hosting websites, web apps, and games.
-- A friendly, open-source project and community to learn about web development, cloud computing, distributed systems, and much more!
-
-<br/>
-
-
-### ❓ Why isn't Puter built with React, Angular, Vue, etc.?
-
-For performance reasons, Puter is built with vanilla JavaScript and jQuery. Additionally, we'd like to avoid complex abstractions and to remain in control of the entire stack, as much as possible.
-
-Also partly inspired by some of our favorite projects that are not built with frameworks: [VSCode](https://github.com/microsoft/vscode), [Photopea](https://www.photopea.com/), and [OnlyOffice](https://www.onlyoffice.com/).
-
-<br/>
-
-### ❓ Why jQuery?
-
-Puter interacts directly with the DOM and jQuery provides an elegant yet powerful API to manipulate the DOM, handle events, and much more. It's also fast, mature, and battle-tested. 
-
-<br/>
-
 ## #DoesItRunPuter
 
 - [Minecraft](https://twitter.com/HeyPuter/status/1771957571496092036) | [video](https://www.youtube.com/watch?v=GIowZUXkg5g)
@@ -164,19 +100,3 @@ Puter interacts directly with the DOM and jQuery provides an elegant yet powerfu
 - [Tesla Model Y](https://twitter.com/HeyPuter/status/1772858333751636310)
 - [Nintendo Switch](https://twitter.com/HeyPuter/status/1780645795240538518)
 - [Steam Deck](https://twitter.com/everythingSung/status/1782162352403828793)
-
-<br/>
-
-## Credits
-
-The default wallpaper is created by [Milad Fakurian](https://unsplash.com/photos/blue-orange-and-yellow-wallpaper-E8Ufcyxz514) and published on [Unsplash](https://unsplash.com/).
-
-Icons by [Papirus](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme) under GPL-3.0 license.
-
-Icons by [Iconoir](https://iconoir.com/) under MIT license.
-
-Icons by [Elementary Icons](https://github.com/elementary/icons) under GPL-3.0 license.
-
-Icons by [Tabler Icons](https://tabler.io/) under MIT license.
-
-Icons by [bootstrap-icons](https://icons.getbootstrap.com/) under MIT license.

doc/api/README.md

@@ -0,0 +1,5 @@
+# API Documentation
+
+Note that this documentation is different from the [puter.js docs](https://docs.puter.com).
+The scope of the documentation in this directory includes both stable API endpoints that
+are used by **puter.js**, as well as API endpoints that may be subject to future changes.

doc/api/concepts/share-link.md

@@ -0,0 +1,9 @@
+# Share Links
+
+A **share link** is a link to Puter's origin which contains a token
+in the query string (the key is `share_token`; ex:
+`http://puter.localhost:4100?share_token=...`).
+
+This token can be used to apply permissions to the user of the
+current session **if and only if** this user's email is confirmed
+and matches the share link's associated email.