docs: example GitHub action

.env.development

@@ -3,6 +3,9 @@ ADMIN_TOKEN=devadmintoken
 # Docker host binding (used by docker compose for port mapping)
 HOST=127.0.0.1
 PORT=8080
+# User and group for file ownership (should match system user on host)
+UID=1000
+GID=1000
 
 # Optional: Service configuration (defaults shown)
 DEPLOY_ROOT=/var/www/docs

.env.example

@@ -1,14 +1,19 @@
 # Docker Compose Variables (used for port mapping)
-# Copy this file to .env for docker-compose to use
+# Copy this file to .env for docker compose to use
 
 # The Go service always binds to 0.0.0.0:8080 inside the container
 HOST=0.0.0.0
 PORT=8080
+# User and group for file ownership (MUST match system user on host)
+UID=1000
+GID=1000
+
 # Required: Admin bearer token for API access
-ADMIN_TOKEN=your-secure-admin-token-here # TODO: generate a secure token
+ADMIN_TOKEN=your-secure-admin-token-here
+
 # Optional: Service configuration (defaults shown)
-DEPLOY_ROOT=/var/www/tingz-docs
-RELEASE_ROOT=/var/www/tingz-deploys
+DEPLOY_ROOT=/var/www/docs
+RELEASE_ROOT=/var/www/deploys
 DB_PATH=/data/deployer.db
 
 # Optional: Upload and retention settings

API.md

@@ -0,0 +1,364 @@
+# API with cURL
+
+Complete guide to tingz API with cURL.
+
+## Assumptions
+
+- Running deployer service on http://localhost:8080
+- Admin token (set in `.env.development` as `ADMIN_TOKEN`) set to `devadmintoken`
+- API version is `v1`
+- **Note:** The deployer service only handles API requests (`/api/v1/*`). For serving deployed static sites, you need a separate web server (Caddy, nginx, etc.) configured to serve files from `/var/www/docs`
+
+## Step 1: Create a User (Admin Only)
+
+First, an admin needs to create a user account to get a deployment token.
+
+```bash
+curl -X POST "http://localhost:8080/api/v1/auth" \
+  -H "Authorization: Bearer devadmintoken" \
+  -H "Content-Type: application/json" \
+  -d '{"username":"alice"}'
+```
+
+**Success Response:**
+```json
+{
+  "status": "ok",
+  "token": "82lz0BVOWtV4uVj9DBZBuKMeyVDwidL2"
+}
+```
+
+**Important:** Save this token! You'll need it for all deployments for that user.
+
+### Username Requirements
+- Lowercase letters, numbers, hyphens, underscores only
+- 1-64 characters
+- Must start and end with alphanumeric character
+- Pattern: `^[a-z0-9]([a-z0-9_-]{0,62}[a-z0-9])?$`
+
+## Step 2: Prepare Your Static Site
+
+Package your static site as a `.tar.gz` file with files at the root level.
+
+### Correct Way (Files at Root)
+
+```bash
+cd /path/to/your/site
+tar -czf ../site.tar.gz .
+```
+
+This creates a tarball where `index.html` is at the root, not nested in a directory.
+
+### What NOT to Do
+
+```bash
+# DON'T: This creates site/index.html (nested)
+tar -czf site.tar.gz site/
+
+# DON'T: This creates /path/to/your/site/index.html (nested)
+tar -czf site.tar.gz /path/to/your/site
+```
+
+### Verify Your Tarball
+
+```bash
+tar -tzf site.tar.gz | head -5
+```
+
+Expected output:
+```
+index.html
+css/
+css/style.css
+js/
+js/app.js
+```
+
+NOT:
+```
+site/index.html    ← Wrong! Nested directory
+site/css/style.css
+```
+
+## Step 3: Deploy Your Site
+
+Use your user token to deploy the site.
+
+```bash
+curl -X POST "http://localhost:8080/api/v1/deploy" \
+  -H "Authorization: Bearer YOUR_USER_TOKEN" \
+  -F "project=myproject" \
+  -F "file=@site.tar.gz"
+```
+
+**Success Response:**
+```json
+{
+  "status": "ok",
+  "project": "myproject",
+  "username": "alice",
+  "url": "https://docs.yigid.dev/alice/myproject/",
+  "release": "20251014T180806"
+}
+```
+
+### Project Name Requirements
+- Same rules as username
+- Lowercase, alphanumeric, hyphens, underscores
+- 1-64 characters
+- Pattern: `^[a-z0-9]([a-z0-9_-]{0,62}[a-z0-9])?$`
+
+### Important Notes
+
+- The `@` prefix is required for file uploads: `-F "file=@site.tar.gz"`
+- Max upload size: 100MB (default, configurable)
+- Files are deployed to: `/var/www/docs/{username}/{project}/`
+- Each deployment creates a new release in `/var/www/deploys/{username}/{project}/{release_id}/`
+- The deploy directory is an atomic symlink to the latest release
+- Old releases are kept (5 by default) for rollback
+
+## Step 4: Verify Deployment
+
+### Check the Symlink
+
+```bash
+ls -la docs/alice/myproject
+```
+
+Output:
+```
+lrwxr-xr-x  1 deployer deployer  47 Oct 14 21:08 myproject -> /var/www/deploys/alice/myproject/20251014T180806
+```
+
+### Check the Files
+
+```bash
+ls -la deploys/alice/myproject/20251014T180806/
+```
+
+### Access Your Site
+
+**Note:** The deployer service only handles API requests. Deployed sites are served by a separate web server (like Caddy or nginx) that reads from `/var/www/docs`.
+
+```bash
+# If you have a web server configured to serve from /var/www/docs:
+curl https://docs.yigid.dev/alice/myproject/
+```
+
+**For local development:** You'll need to set up a web server to serve files from the `docs/` directory, or use a simple HTTP server:
+
+```bash
+# Example: serve files from docs directory
+cd docs && python3 -m http.server 3000
+# Then access: http://localhost:3000/alice/myproject/
+```
+
+## Complete Workflow Example
+
+```bash
+# 1. Set your admin token
+export ADMIN_TOKEN="devadmintoken"
+
+# 2. Create user and capture token
+USER_TOKEN=$(curl -s -X POST "http://localhost:8080/api/v1/auth" \
+  -H "Authorization: Bearer ${ADMIN_TOKEN}" \
+  -H "Content-Type: application/json" \
+  -d '{"username":"alice"}' | jq -r '.token')
+
+echo "User token: ${USER_TOKEN}"
+
+# 3. Create test site
+mkdir -p my-site
+cat > my-site/index.html << 'EOF'
+<!DOCTYPE html>
+<html>
+<head><title>My Site</title></head>
+<body><h1>Hello, World!</h1></body>
+</html>
+EOF
+
+# 4. Package site
+tar -czf site.tar.gz -C my-site .
+
+# 5. Deploy
+curl -s -X POST "http://localhost:8080/api/v1/deploy" \
+  -H "Authorization: Bearer ${USER_TOKEN}" \
+  -F "project=mysite" \
+  -F "file=@site.tar.gz" | jq
+
+# 6. Verify (requires web server setup)
+# If you have a web server serving from docs/ directory:
+curl http://localhost:3000/alice/mysite/
+```
+
+## Health Check
+
+Test if the service is running:
+
+```bash
+curl http://localhost:8080/api/v1/status
+```
+
+Expected response:
+```json
+{
+  "status": "ok"
+}
+```
+
+## Error Responses
+
+### Invalid Token
+```json
+{
+  "status": "error",
+  "error": "unauthorized"
+}
+```
+
+### Invalid Project Name
+```json
+{
+  "status": "error",
+  "error": "invalid project name format"
+}
+```
+
+### Missing File
+```json
+{
+  "status": "error",
+  "error": "missing or invalid file"
+}
+```
+
+### Upload Too Large
+```json
+{
+  "status": "error",
+  "error": "request body too large"
+}
+```
+
+### Path Traversal in Tarball
+```json
+{
+  "status": "error",
+  "error": "failed to extract tarball: path contains '..' component which is not allowed: ../../etc/passwd"
+}
+```
+
+## User Management (Admin Only)
+
+### Reroll User Token
+
+Create a new token for an existing user (invalidates old token):
+
+```bash
+curl -X POST "http://localhost:8080/api/v1/auth" \
+  -H "Authorization: Bearer ${ADMIN_TOKEN}" \
+  -H "Content-Type: application/json" \
+  -d '{"username":"alice"}'
+```
+
+### Delete User (Keep Files)
+
+```bash
+curl -X DELETE "http://localhost:8080/api/v1/auth" \
+  -H "Authorization: Bearer ${ADMIN_TOKEN}" \
+  -H "Content-Type: application/json" \
+  -d '{"username":"alice","files":"persist"}'
+```
+
+### Delete User and All Files
+
+```bash
+curl -X DELETE "http://localhost:8080/api/v1/auth" \
+  -H "Authorization: Bearer ${ADMIN_TOKEN}" \
+  -H "Content-Type: application/json" \
+  -d '{"username":"alice","files":"delete"}'
+```
+
+## CI/CD Integration
+
+### GitHub Actions
+
+```yaml
+name: Deploy Documentation
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Build site
+        run: |
+          # Your build steps here
+          npm run build
+      
+      - name: Package and deploy
+        env:
+          DEPLOYER_TOKEN: ${{ secrets.DEPLOYER_TOKEN }}
+        run: |
+          tar -czf site.tar.gz -C dist .
+          curl -f -X POST "https://deployer.example.com/api/v1/deploy" \
+            -H "Authorization: Bearer ${DEPLOYER_TOKEN}" \
+            -F "project=docs" \
+            -F "file=@site.tar.gz"
+```
+
+### GitLab CI
+
+```yaml
+deploy:
+  stage: deploy
+  only:
+    - main
+  script:
+    - tar -czf site.tar.gz -C public .
+    - |
+      curl -f -X POST "https://deployer.example.com/api/v1/deploy" \
+        -H "Authorization: Bearer ${DEPLOYER_TOKEN}" \
+        -F "project=docs" \
+        -F "file=@site.tar.gz"
+  variables:
+    DEPLOYER_TOKEN: $DEPLOYER_TOKEN
+```
+
+## Tips & Best Practices
+
+1. **Always use `@` for file uploads**: `-F "file=@your-file.tar.gz"`
+
+2. **Verify tarball contents** before deploying:
+   ```bash
+   tar -tzf site.tar.gz | head -20
+   ```
+
+3. **Use `-f` flag in CI/CD** to fail on HTTP errors:
+   ```bash
+   curl -f -X POST ...
+   ```
+
+4. **Pretty-print JSON responses** with `jq`:
+   ```bash
+   curl ... | jq
+   ```
+
+5. **Avoid macOS resource forks** in tarballs:
+   ```bash
+   COPYFILE_DISABLE=1 tar -czf site.tar.gz -C dist .
+   ```
+
+6. **Check release history**:
+   ```bash
+   ls -lt deploys/alice/myproject/
+   ```
+
+7. **Atomic deployments**: The symlink swap is atomic, so no downtime during deployment
+
+8. **Release retention**: Old releases are kept (5 by default) for manual rollback if needed
+

Dockerfile

@@ -17,12 +17,16 @@ RUN CGO_ENABLED=0 GOOS=linux GOARCH=${TARGETARCH} go build \
 
 FROM alpine:latest
 
-RUN adduser -D -u 1000 deployer && \
-    chown -R deployer:deployer /tmp
+ARG UID
+ARG GID
+
+RUN addgroup -g ${GID} -S tingz && \
+    adduser -u ${UID} -S -G tingz -s /sbin/nologin tingz && \
+    chown -R tingz:tingz /tmp
 
 COPY --from=builder /bin/deployer /deployer
 
-USER deployer
+USER tingz
 
 EXPOSE 8080
 

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

README.md

@@ -0,0 +1,53 @@
+## tingz: stay deployin'
+
+A secure, lightweight HTTP service for deploying static site artifacts with per-user directory isolation. Tested on Debian 12.
+
+### Quick Start
+
+#### Production Deployment
+
+**Prerequisites**:
+- Go 1.25.3+
+- Docker & Docker Compose
+- Admin token (secure random string, `openssl rand -hex 16`)
+
+##### Create Restricted User
+
+```shell
+addgroup --system tingz # note gid, needed for 2nd command
+adduser --ingroup tingz --system --no-create-home --uid ${GID} --shell /usr/sbin/nologin tingz
+usermod -aG tingz caddy
+```
+
+##### Deploy
+
+1. Get source and checkout to a stable tag
+
+```shell
+git clone https://git.yigid.dev/fyb/tingz.git
+cd tingz
+git checkout v1.0
+```
+
+2. Edit the environment variables
+
+```shell
+cp .env.example .env
+vim .env
+```
+
+3. Run with Docker
+
+```shell
+docker compose up --build -d
+```
+
+### API Usage
+
+See [API.md](API.md).
+
+### License & Credits
+
+[GNU AGPL v3](LICENSE), by [Yigid BALABAN](https://git.yigid.dev/fyb).
+
+Reach me at [hey@yigid.dev](mailto:hey@yigid.dev).

docker-compose.yml

@@ -1,14 +1,19 @@
 services:
   server:
-    build: .
     container_name: tingz-server
-    restart: unless-stopped
-    env_file: .env.development
+    env_file: .env
+    build:
+      context: .
+      args:
+        UID: ${UID}
+        GID: ${GID}
+    # for the volumes below, ensure the server user has write access
+    # "server user" is the user that UID and GID's are passed with env variables
     volumes:
-      - ./data:/data
-      - ./docs:/var/www/docs
-      - ./deploys:/var/www/deploys
+      - ./volumes/data:/data # SQLite DB
+      - ./volumes/docs:/var/www/docs # published files
+      - ./volumes/deploys:/var/www/deploys # releases
     ports:
       - "${HOST}:${PORT}:8080"
-    user: "1000:1000"
-
+    user: "${UID}:${GID}"
+    restart: unless-stopped

example.caddy

@@ -0,0 +1,21 @@
+docs.example.org {
+    # API requests go to Docker container
+    handle /api* {
+        reverse_proxy HOST:PORT # TODO: set to HOST and PORT from .env
+    }
+
+    handle {
+        file_server {
+            root $COMPOSE_DIR/volumes/docs # TODO: change $COMPOSE_DIR to the actual path
+            index index.html
+            browse off
+        }
+    }
+
+    #log {
+    #    output_file /var/log/caddy/docs.example.org.log {
+    #        roll_size 10MB
+    #        roll_keep 10
+    #    }
+    #}
+}

internal/deploy/manager.go

@@ -68,6 +68,10 @@ func (m *Manager) Deploy(ctx context.Context, username, project string, r io.Rea
 		return "", fmt.Errorf("failed to extract tarball: %w", err)
 	}
 
+	if err := m.lockdownPermissions(releasePath); err != nil {
+		return "", fmt.Errorf("failed to set read-only permissions: %w", err)
+	}
+
 	deployPath := filepath.Join(m.deployRoot, username, project)
 	deployParentDir := filepath.Dir(deployPath)
 	if err := os.MkdirAll(deployParentDir, 0755); err != nil {
@@ -178,6 +182,26 @@ func validateTarPath(path string) error {
 	return nil
 }
 
+func (m *Manager) lockdownPermissions(root string) error {
+	return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if info.IsDir() {
+			if err := os.Chmod(path, 0550); err != nil {
+				return fmt.Errorf("failed to chmod directory %s: %w", path, err)
+			}
+		} else {
+			if err := os.Chmod(path, 0440); err != nil {
+				return fmt.Errorf("failed to chmod file %s: %w", path, err)
+			}
+		}
+
+		return nil
+	})
+}
+
 func (m *Manager) cleanupOldReleases(username, project string) error {
 	releasesDir := filepath.Join(m.releaseRoot, username, project)
 

internal/http/handlers.go

@@ -202,6 +202,14 @@ func (s *Server) handleStatus(w http.ResponseWriter, r *http.Request) {
 	})
 }
 
+func (s *Server) handleHello(w http.ResponseWriter, r *http.Request) {
+	writeJSON(w, http.StatusOK, map[string]string{
+		"message":        "Close the world, .txen eht nepO",
+		"author":         "Yigid BALABAN <hey@yigid.dev>",
+		"authorHomepage": "https://yigid.dev/",
+	})
+}
+
 func writeJSON(w http.ResponseWriter, status int, data interface{}) {
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(status)

internal/http/router.go

@@ -23,6 +23,7 @@ func NewRouter(cfg *config.Config, userMgr *user.Manager, deployMgr *deploy.Mana
 	mux.Handle("DELETE /api/v1/auth", adminAuth(http.HandlerFunc(server.handleAuthDelete)))
 	mux.Handle("POST /api/v1/deploy", userAuth(maxBytes(http.HandlerFunc(server.handleDeploy))))
 	mux.HandleFunc("GET /api/v1/status", server.handleStatus)
+	mux.HandleFunc("GET /api/hello", server.handleHello)
 
 	return LoggingMiddleware(logger)(mux)
 }

openapi.yaml

@@ -0,0 +1,444 @@
+openapi: 3.0.3
+info:
+  title: Tingz Deployer API
+  description: A secure, lightweight HTTP service for deploying static sites. The service receives tarball artifacts, validates and publishes them under a per-user directory structure for docs.yigid.dev. Designed for CI/CD automation with GitHub Actions, GitLab CI, etc.
+  version: 1.0.0
+  contact:
+    name: Yigid BALABAN
+    email: hey@yigid.dev
+    url: https://yigid.dev/
+  license:
+    name: AGPL-3.0-only 
+    url: https://opensource.org/license/agpl-v3
+servers:
+  - url: https://docs.yigid.dev
+    description: Production server
+  - url: http://localhost:8080
+    description: Development server
+paths:
+  /api/v1/auth:
+    post:
+      tags:
+        - Authentication
+      summary: Create or reroll user token
+      description: Creates a new user or generates a new token for an existing user. Admin only endpoint.
+      operationId: createOrRerollUser
+      security:
+        - AdminAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateUserRequest'
+            example:
+              username: alice
+      responses:
+        '200':
+          description: User created or token rerolled successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuthResponse'
+              example:
+                status: ok
+                token: 82lz0BVOWtV4uVj9DBZBuKMeyVDwidL2
+        '400':
+          description: Invalid request body or username format
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                invalidBody:
+                  summary: Invalid request body
+                  value:
+                    status: error
+                    error: invalid request body
+                invalidUsername:
+                  summary: Invalid username format
+                  value:
+                    status: error
+                    error: invalid username format
+        '401':
+          description: Unauthorized - Invalid admin token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              example:
+                status: error
+                error: invalid admin token
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              example:
+                status: error
+                error: failed to create user
+    delete:
+      tags:
+        - Authentication
+      summary: Delete user
+      description: Deletes a user and optionally their files. Admin only endpoint.
+      operationId: deleteUser
+      security:
+        - AdminAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DeleteUserRequest'
+            examples:
+              persistFiles:
+                summary: Delete user but keep files
+                value:
+                  username: alice
+                  files: persist
+              deleteFiles:
+                summary: Delete user and all files
+                value:
+                  username: alice
+                  files: delete
+      responses:
+        '200':
+          description: User deleted successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SuccessResponse'
+              example:
+                status: ok
+        '400':
+          description: Invalid request body, username format, or files parameter
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                invalidBody:
+                  summary: Invalid request body
+                  value:
+                    status: error
+                    error: invalid request body
+                invalidUsername:
+                  summary: Invalid username format
+                  value:
+                    status: error
+                    error: invalid username format
+                invalidFiles:
+                  summary: Invalid files parameter
+                  value:
+                    status: error
+                    error: files must be 'persist' or 'delete'
+        '401':
+          description: Unauthorized - Invalid admin token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              example:
+                status: error
+                error: invalid admin token
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              example:
+                status: error
+                error: user not found
+  /api/v1/deploy:
+    post:
+      tags:
+        - Deployment
+      summary: Deploy static site
+      description: Uploads and deploys a static site tarball. Creates a new release and atomically updates the live site via symlink swap.
+      operationId: deploySite
+      security:
+        - UserAuth: []
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required:
+                - project
+                - file
+              properties:
+                project:
+                  type: string
+                  description: Project name (must match username validation pattern)
+                  pattern: ^[a-z0-9]([a-z0-9_-]{0,62}[a-z0-9])?$
+                  minLength: 1
+                  maxLength: 64
+                  example: myproject
+                file:
+                  type: string
+                  format: binary
+                  description: Tarball file (.tar.gz) containing the static site
+      responses:
+        '200':
+          description: Deployment successful
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DeployResponse'
+              example:
+                status: ok
+                project: myproject
+                username: alice
+                url: https://docs.yigid.dev/alice/myproject/
+                release: 20251014T180806
+        '400':
+          description: Invalid request - missing file, invalid project name, or multipart form parsing error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                missingFile:
+                  summary: Missing or invalid file
+                  value:
+                    status: error
+                    error: missing or invalid file
+                invalidProject:
+                  summary: Invalid project name format
+                  value:
+                    status: error
+                    error: invalid project name format
+                parseError:
+                  summary: Failed to parse multipart form
+                  value:
+                    status: error
+                    error: failed to parse multipart form
+        '401':
+          description: Unauthorized - Invalid user token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              example:
+                status: error
+                error: unauthorized
+        '413':
+          description: Request entity too large - Upload exceeds maximum size limit
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              example:
+                status: error
+                error: request body too large
+        '500':
+          description: Internal server error during deployment
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                extractionError:
+                  summary: Failed to extract tarball
+                  value:
+                    status: error
+                    error: 'failed to extract tarball: path contains ''..'' component which is not allowed: ../../etc/passwd'
+                generalError:
+                  summary: General deployment error
+                  value:
+                    status: error
+                    error: deployment failed
+  /api/v1/status:
+    get:
+      tags:
+        - Health
+      summary: Health check
+      description: Returns the current status of the service
+      operationId: getStatus
+      responses:
+        '200':
+          description: Service is healthy
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StatusResponse'
+              example:
+                status: ok
+  /api/hello:
+    get:
+      tags:
+        - Info
+      summary: Service information
+      description: Returns basic information about the service and author
+      operationId: getHello
+      responses:
+        '200':
+          description: Service information
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HelloResponse'
+              example:
+                message: Close the world, .txen eht nepO
+                author: Yigid BALABAN <hey@yigid.dev>
+                authorHomepage: https://yigid.dev/
+components:
+  securitySchemes:
+    AdminAuth:
+      type: http
+      scheme: bearer
+      description: Admin bearer token for user management operations
+    UserAuth:
+      type: http
+      scheme: bearer
+      description: User bearer token for deployment operations
+  schemas:
+    CreateUserRequest:
+      type: object
+      required:
+        - username
+      properties:
+        username:
+          type: string
+          description: Username for the new user (lowercase letters, numbers, hyphens, underscores only)
+          pattern: ^[a-z0-9]([a-z0-9_-]{0,62}[a-z0-9])?$
+          minLength: 1
+          maxLength: 64
+          example: alice
+    DeleteUserRequest:
+      type: object
+      required:
+        - username
+      properties:
+        username:
+          type: string
+          description: Username of the user to delete
+          pattern: ^[a-z0-9]([a-z0-9_-]{0,62}[a-z0-9])?$
+          minLength: 1
+          maxLength: 64
+          example: alice
+        files:
+          type: string
+          description: Whether to persist or delete user files
+          enum:
+            - persist
+            - delete
+          default: persist
+          example: persist
+    AuthResponse:
+      type: object
+      required:
+        - status
+        - token
+      properties:
+        status:
+          type: string
+          enum:
+            - ok
+          example: ok
+        token:
+          type: string
+          description: 32-character alphanumeric token for API access
+          minLength: 32
+          maxLength: 32
+          example: 82lz0BVOWtV4uVj9DBZBuKMeyVDwidL2
+    DeployResponse:
+      type: object
+      required:
+        - status
+        - project
+        - username
+        - url
+        - release
+      properties:
+        status:
+          type: string
+          enum:
+            - ok
+          example: ok
+        project:
+          type: string
+          description: Project name
+          example: myproject
+        username:
+          type: string
+          description: Username who deployed
+          example: alice
+        url:
+          type: string
+          format: uri
+          description: Public URL where the site is accessible
+          example: https://docs.yigid.dev/alice/myproject/
+        release:
+          type: string
+          description: 'Release ID (timestamp format: YYYYMMDDTHHMMSS)'
+          pattern: ^[0-9]{8}T[0-9]{6}$
+          example: 20251014T180806
+    StatusResponse:
+      type: object
+      required:
+        - status
+      properties:
+        status:
+          type: string
+          enum:
+            - ok
+          example: ok
+    HelloResponse:
+      type: object
+      required:
+        - message
+        - author
+        - authorHomepage
+      properties:
+        message:
+          type: string
+          description: Service message
+          example: Close the world, .txen eht nepO
+        author:
+          type: string
+          description: Author information
+          example: Yigid BALABAN <hey@yigid.dev>
+        authorHomepage:
+          type: string
+          format: uri
+          description: Author homepage URL
+          example: https://yigid.dev/
+    SuccessResponse:
+      type: object
+      required:
+        - status
+      properties:
+        status:
+          type: string
+          enum:
+            - ok
+          example: ok
+    ErrorResponse:
+      type: object
+      required:
+        - status
+        - error
+      properties:
+        status:
+          type: string
+          enum:
+            - error
+          example: error
+        error:
+          type: string
+          description: Error message describing what went wrong
+          example: invalid username format
+tags:
+  - name: Authentication
+    description: User management operations (admin only)
+  - name: Deployment
+    description: Static site deployment operations
+  - name: Health
+    description: Service health and status endpoints
+  - name: Info
+    description: Service information endpoints

pre-docker-deploy.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+set -euxo pipefail
+
+echo "=== tingz pre-docker script ==="
+echo "This script assumes you're running it on a Debian 12+ system."
+echo "This script assumes you haven't created a tingz user & group yet."
+echo "This script assumes you are using the default volumes directory structure."
+echo
+echo "Description:"
+echo "This script creates a tingz user & group,"
+echo "creates and sets permissions for volumes,"
+echo "and creates a .env.development file."
+echo
+
+echo "1. Check dependencies"
+commands=(docker adduser addgroup cut getent)
+for cmd in "${commands[@]}"; do
+  if ! command -v "$cmd" &> /dev/null; then
+    echo "Error: $cmd could not be found"
+    exit 1
+  fi
+done
+
+echo "2. Add tingz user & group"
+addgroup --system tingz
+GID=$(getent group tingz | cut -d: -f3)
+adduser --ingroup tingz --system --no-create-home --uid ${GID} --shell /usr/sbin/nologin tingz
+
+echo "3. Verify tingz group and user"
+getent group tingz
+getent passwd tingz
+
+echo "4. Create and set permissions for volumes"
+mkdir -p volumes/data volumes/docs volumes/deploys
+chown -R tingz:tingz volumes
+
+echo "5. Create .env.tmp file"
+ADMIN_TOKEN=$(openssl rand -hex 16)
+cat > .env.tmp << EOF
+ADMIN_TOKEN=${ADMIN_TOKEN}
+HOST=127.0.0.1
+PORT=8080
+UID=${GID}
+GID=${GID}
+DEPLOY_ROOT=/var/www/docs
+RELEASE_ROOT=/var/www/deploys
+DB_PATH=/data/deployer.db
+MAX_UPLOAD_SIZE=104857600
+EOF
+
+echo "Please verify .env.temp and move into .env if everything is correct"
+echo "=== .env.tmp ==="
+cat .env.tmp
+echo "=== .env ==="
+
+echo "Done"

test-deployment.sh

@@ -95,4 +95,3 @@ rm -rf "$TEST_DIR"
 
 echo
 echo "=== All tests passed! ==="
-

workflows/gh-actions.yml

@@ -0,0 +1,48 @@
+name: Deploy with mdBook to docs.yigid.dev
+
+on:
+  push:
+    paths:
+      - docs/**
+    branches:
+      - main
+
+  workflow_dispatch:
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "mdbook"
+  cancel-in-progress: true
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup mdBook
+        uses: jontze/action-mdbook@v3
+        with:
+          token: ${{secrets.GITHUB_TOKEN}}
+          use-linkcheck: true
+          use-mermaid: true
+
+      - name: Build with mdBook
+        run: mdbook build docs
+
+      - name: Create tarball
+        run: |
+          cd docs/book
+          tar -czf ../docs.tar.gz .
+
+      - name: Deploy to yigiDDocs
+        env:
+          DEPLOYER_TOKEN: ${{ secrets.DEPLOYER_TOKEN }} # TODO: set secret to token from auth endpoint
+          DEPLOYER_URL: https://docs.yigid.dev
+          PROJECT_NAME: project_name # TODO: change to the actual project name
+        run: |
+          curl -f -X POST "${DEPLOYER_URL}/api/v1/deploy" \
+            -H "Authorization: Bearer ${DEPLOYER_TOKEN}" \
+            -F "project=${PROJECT_NAME}" \
+            -F "file=@docs/docs.tar.gz"