ownfoil 2.4.0.dev1__tar.gz → 2.4.2__tar.gz

ownfoil-2.4.2/.github/workflows/build_check.yml

@@ -0,0 +1,20 @@
+name: Validate Python package build
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    name: uv build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build package
+        run: uv build

ownfoil-2.4.2/.github/workflows/fixed_comment.yml

@@ -0,0 +1,19 @@
+name: 'Comment on fixed issues'
+on:
+  issues:
+    types: [labeled]
+
+jobs:
+  comment:
+    if: github.event.label.name == 'fixed'
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: Comment on issue
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          ISSUE: ${{ github.event.issue.number }}
+        run: |
+          gh issue comment "$ISSUE" --body 'This issue is fixed in the `develop` branch/image, you can try it following the [installation instructions](https://github.com/a1ex4/ownfoil/blob/develop/Install.md#available-versions). The issue will be closed when the next release is published.'

ownfoil-2.4.2/.github/workflows/region_titles.yml

@@ -0,0 +1,136 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Build titledb
+
+# Controls when the workflow will run
+on:
+  schedule:
+    - cron: '0 */4 * * *'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+    inputs:
+      force:
+        description: 'Rebuild even if blawar/titledb has not moved'
+        type: boolean
+        default: false
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      actions: write
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # A no-op run must not conclude as a success: nightly.link serves the latest *successful*
+      # run's artifact to pre-release Ownfoil versions, so it has to keep pointing at a run that
+      # actually uploaded one. Cancelling leaves that resolution untouched.
+      - name: Skip when blawar/titledb has not moved
+        env:
+          GH_TOKEN: ${{ github.token }}
+          # This step runs before the checkout, so gh has no local repo to infer from
+          GH_REPO: ${{ github.repository }}
+        run: |
+          set -euo pipefail
+          remote=$(git ls-remote https://github.com/blawar/titledb.git HEAD | cut -f1)
+          published=$(curl -sfL "https://github.com/${{ github.repository }}/releases/download/titledb/latest" || true)
+          echo "upstream=${remote} published=${published:-<none>}"
+          echo "titledb_sha=${remote}" >> "$GITHUB_ENV"
+          if [ "$remote" = "$published" ] && [ "${{ inputs.force }}" != "true" ]; then
+            echo "titledb unchanged, cancelling this run"
+            gh run cancel "${{ github.run_id }}"
+            sleep 60
+          fi
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: '3.10'
+
+      # Runs a set of commands using the runners shell
+      - name: Setup folders
+        run: |
+          set -euo pipefail
+          sudo apt update && sudo apt install -y libcurl4-openssl-dev libssl-dev
+          git clone https://github.com/blawar/nut
+          cd nut
+          pip install -r requirements.txt
+          mkdir build_artefacts titledb
+          curl -fsSL --retry 3 "https://github.com/blawar/titledb/archive/${titledb_sha}.tar.gz" \
+            | tar -xz --strip-components=1 -C titledb \
+                  --exclude=ncas.json --exclude=cheats.json
+          echo "formatted_date=$(date +"%Y-%m-%d_%H%M%S")" >> $GITHUB_ENV
+          # Short hash inside the artefact: consumed by Ownfoil < 2.4 through nightly.link.
+          # Explicitly 7 chars, matching what --short gave on the old shallow clone.
+          touch "build_artefacts/latest_${titledb_sha:0:7}"
+          # Full hash outside the artefact: the release marker, and what the skip check compares.
+          # Both are now the sha the tarball was pinned to, so they agree by construction.
+          echo "$titledb_sha" > latest
+
+      - uses: jannekem/run-python-script-action@v1
+        name: Generate region titles
+        with:
+          script: |
+            import os, sys
+            import json
+
+            os.chdir('nut')
+            sys.path.append(os.getcwd())
+            import nut
+
+            with open('titledb/languages.json') as f:
+              languages = json.load(f)
+              languages = dict(sorted(languages.items()))
+            for region in languages.keys():
+              for language in languages[region]:
+                  print(region, language)
+                  nut.importRegion(region, language)
+                  os.rename('titledb/titles.json', f'build_artefacts/titles.{region}.{language}.json')
+
+            for f in [
+              'cnmts.json',
+              'languages.json',
+              'versions.json',
+              'versions.txt',
+            ]:
+              os.rename(f'titledb/{f}', f'build_artefacts/{f}')
+
+
+      # Must stay ahead of the compression step: pre-release versions read the uncompressed
+      # JSON straight out of this zip.
+      - uses: actions/upload-artifact@v7
+        with:
+          name: titledb
+          path: nut/build_artefacts/*
+          compression-level: 9
+
+      - name: Compress artefacts
+        run: zstd -12 -T0 --rm -q nut/build_artefacts/*.json nut/build_artefacts/versions.txt
+
+      - name: Publish to the titledb release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          set -euo pipefail
+          gh release view titledb >/dev/null 2>&1 || \
+            gh release create titledb --prerelease --latest=false --title 'titledb data' \
+              --notes 'Rolling titledb dataset consumed by Ownfoil. Assets are replaced in place; `latest` holds the blawar/titledb commit they were built from and is always written last.'
+          uploaded=false
+          for attempt in 1 2 3; do
+            if gh release upload titledb nut/build_artefacts/*.zst --clobber; then
+              uploaded=true
+              break
+            fi
+            echo "upload attempt ${attempt} failed, retrying"
+            sleep 30
+          done
+          # Guards the invariant below: never publish the marker over a half-uploaded dataset
+          [ "$uploaded" = true ]
+          # Written last, alone: a client that sees a new hash knows every asset is already in place
+          gh release upload titledb nut/latest --clobber

ownfoil-2.4.2/.github/workflows/release_close_fixed.yml

@@ -0,0 +1,24 @@
+name: 'Close fixed issues on release'
+on:
+  release:
+    types: [released]
+
+jobs:
+  close:
+    if: '!github.event.release.prerelease'
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: Close issues labeled fixed
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          TAG: ${{ github.event.release.tag_name }}
+          URL: ${{ github.event.release.html_url }}
+        run: |
+          body="This issue has been fixed and released in [Ownfoil ${TAG}](${URL}), closing as completed. Feel free to re-open if needed."
+          for issue in $(gh issue list --label fixed --state open --limit 200 --json number --jq '.[].number'); do
+            gh issue edit "$issue" --remove-label fixed
+            gh issue close "$issue" --reason completed --comment "$body"
+          done

{ownfoil-2.4.0.dev1 → ownfoil-2.4.2}/.github/workflows/stale.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Close stale issues
-        uses: actions/stale@v10
+        uses: actions/stale@v11
         with:
           days-before-stale: 30
           days-before-close: 7

ownfoil-2.4.2/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Tests on ${{ matrix.os }}
+    if: ${{ !startsWith(github.event.head_commit.message, 'ci') && !startsWith(github.event.head_commit.message, 'doc') }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: '3.14'
+          enable-cache: true
+          cache-dependency-glob: requirements.txt
+
+      - name: Create virtualenv
+        run: uv venv
+
+      - name: Install dependencies
+        run: uv pip install --requirement requirements.txt pytest
+
+      - name: Run tests
+        run: uv run pytest tests -v
+        timeout-minutes: 20

{ownfoil-2.4.0.dev1 → ownfoil-2.4.2}/.gitignore

@@ -2,6 +2,9 @@ __pycache__
 config
 data
 
+# capture harness workdir: fixture db, settings and the pseudonym map
+tests/capture/.workdir
+
 # venv
 /bin
 /venv

{ownfoil-2.4.0.dev1 → ownfoil-2.4.2}/Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.14-alpine
 
 # Install platform-specific build dependencies
 ARG TARGETPLATFORM
-RUN apk update && apk add --no-cache bash sudo git \
+RUN apk update && apk add --no-cache bash sudo \
     && if [ "$TARGETPLATFORM" = "linux/arm/v6" ] || [ "$TARGETPLATFORM" = "linux/arm/v7" ]; then \
         apk add --no-cache build-base gcc musl-dev jpeg-dev zlib-dev libffi-dev cairo-dev pango-dev gdk-pixbuf-dev; \
     fi

ownfoil-2.4.2/Install.md

@@ -0,0 +1,208 @@
+# Installing Ownfoil
+
+Ownfoil is a web server listening on port `8465`, so anything that can run a Docker container or a Python environment will do - a NAS, a Raspberry Pi, an old laptop or your own desktop.
+
+- [Using Docker](#using-docker)
+- [Using uv (Windows users do this)](#using-uv)
+- [Using Unraid](#using-unraid)
+- [Using Proxmox LXC](#using-proxmox-lxc)
+- [Using the Helm chart](#using-the-helm-chart)
+- [Available versions](#available-versions)
+
+> [!CAUTION]
+> There is __no website associated with this project__, only this GitHub repo.  
+> Ownfoil is __not released as an application or an executable file__ - DO NOT download or execute anything related to Ownfoil outside of this repository and its instructions.
+
+# Using Docker
+Ownfoil is shipped as a docker container for easy deployment, data persistency and updates. If you are unfamiliar with Docker, check [the installation documentation here](https://docs.docker.com/engine/install/).  
+## Docker run
+
+<details>
+
+Running this command will start the shop on local port `8465` with the library in `/your/game/directory`, and persist the `data` and `config` directories:
+```
+docker run -d -p 8465:8465 \
+   -v /your/game/directory:/games \
+   -v ./config:/app/config \
+   -v ./data:/app/data \
+   --name ownfoil \
+   a1ex4/ownfoil
+```
+To see the logs of the container:  
+
+      docker logs -f ownfoil
+
+</details>
+
+## Docker compose
+<details>
+
+Create a file named `docker-compose.yml` with the following content:
+```
+---
+services:
+  ownfoil:
+    container_name: ownfoil
+    image: a1ex4/ownfoil
+   # environment:
+   #   # For write permission in config directory
+   #   - PUID=1000
+   #   - PGID=1000
+   #   # to create/update an admin user at startup
+   #   - USER_ADMIN_NAME=admin
+   #   - USER_ADMIN_PASSWORD=asdvnf!546
+   #   # to create/update a regular user at startup
+   #   - USER_GUEST_NAME=guest
+   #   - USER_GUEST_PASSWORD=oerze!@8981
+    volumes:
+      - /your/game/directory:/games
+      - ./data:/app/data
+      - ./config:/app/config
+    ports:
+      - "8465:8465"
+```
+
+You can then create and start the container with the command (executed in the same directory as the docker-compose file):
+
+    docker-compose up -d
+
+This is usefull if you don't want to remember the `docker run` command and have a persistent and reproductible container configuration.
+</details>
+
+## Volumes
+
+| Container path | What to mount there |
+| --- | --- |
+| `/games` | Your library. You can mount several of them, and add each one in the `Settings`. |
+| `/app/config` | The config directory. Back this one up. |
+| `/app/data` | The titledb cache. |
+
+## Environment variables
+
+| Variable | Description |
+| --- | --- |
+| `PUID` / `PGID` | UID and GID of the user running the app in the container, `1000:1000` by default. |
+| `USER_ADMIN_NAME` / `USER_ADMIN_PASSWORD` | Creates (or updates) an admin user at every startup. |
+| `USER_GUEST_NAME` / `USER_GUEST_PASSWORD` | Creates (or updates) a regular user with shop access at every startup. |
+
+> [!TIP]
+> You can control the `UID` and `GID` of the user running the app in the container with the `PUID` and `PGID` environment variables. By default the user is created with `1000:1000`. If you want to have the same ownership for mounted directories, you need to set those variables with the UID and GID returned by the `id` command.
+
+# Using uv
+Ownfoil can be run with [uv](https://docs.astral.sh/uv/getting-started/installation/) without cloning this repository or managing a Python environment yourself. This is the easiest way to run it on Windows.
+<details>
+
+After installing `uv`, open a terminal (Press `Win + R`, type `wt`, and press `Enter`), then either:
+* Run it once, without installing anything permanently:
+```
+uvx ownfoil
+```
+* Install it as a persistent uv tool, so the `ownfoil` command stays available:
+```
+uv tool install ownfoil
+ownfoil
+```
+By default, `config/` and `data/` are created in the current directory. Pass a directory to use instead (works the same way with `uvx`, just append it after `ownfoil`):
+```
+ownfoil /path/to/persist
+uvx ownfoil /path/to/persist
+```
+
+On Windows, the first run also creates an `ownfoil.bat` next to `config/` and `data/`, so you can start Ownfoil again by double-clicking it instead of reopening a terminal.  
+The Web UI opens in your default browser once the server is ready. Pass `--no-browser` (or set `OWNFOIL_NO_BROWSER=1`) to disable it:
+
+```
+ownfoil --no-browser
+```
+
+On Windows, Gunicorn cannot run, so it's best suited for local/personal use there rather than a production deployment.
+</details>
+
+# Using Unraid
+
+Ownfoil is available on the [Community Apps store](https://ca.unraid.net/apps/ownfoil-19wo90o0t5ul8s), install it from the template.
+
+# Using Proxmox LXC
+
+If you run Proxmox, the [community scripts](https://community-scripts.org/scripts/ownfoil) project maintains a script that builds an LXC container with Ownfoil already installed and running as a service - follow the instructions on that page.
+
+> [!TIP]
+> That script is maintained by the community scripts project, not by this repository. If something goes wrong with the container itself, report it to them rather than here.
+
+# Using the Helm chart
+
+The chart lives in [`chart/`](./chart) of this repository - there is no chart repository to add, so clone this repo first, then from the `chart` directory:
+
+```
+helm upgrade --install ownfoil ./ -n namespace -f values.yaml
+```
+
+# Remote access and HTTPS
+
+Exposing your shop to the internet is done with a reverse proxy in front of Ownfoil, and there are a few things it must get right.
+
+* Send the `X-Forwarded-Proto` header, and make sure it does __not__ serve the shop over plain `http` (or redirect it to `https`). Ownfoil only enforces host verification on secure requests, so a proxy that leaves `http` open means anyone who learns your URL can use your shop.
+* Don't set a small request body limit, clients download multi-GB files through it.
+
+Once that is done, set the `Shop URL` in the `Settings` to the same hostname - see [Shop](./Usage.md#shop) for what it does and how to configure it.
+
+# First run
+
+On the first start Ownfoil creates the `config` and `data` directories, downloads titledb, and starts serving the Web UI on port `8465`. Open it with your computer/server IP and port, i.e. `http://localhost:8465` from the same computer or `http://192.168.1.100:8465` from a device in your network.
+
+> [!CAUTION]
+> Until an admin account is created, __authentication is disabled and anyone who can reach the Web UI can change the configuration of your shop__. Creating that account is the first thing to do.
+
+Head over to [First steps](./Usage.md#using-ownfoil) to configure your shop.
+
+# Updating
+
+Updating is just replacing the version you run.
+
+* Docker: `docker pull a1ex4/ownfoil` then recreate the container
+* Docker compose: `docker compose pull && docker compose up -d`
+* uv tool: `uv tool upgrade ownfoil`
+* uvx: nothing to do, it fetches the latest version every time
+* Helm: bump `image.tag` and run the `helm upgrade` command again
+
+# Available versions
+
+Whichever way you install it, you run one of these:
+
+| Version | What you get |
+| --- | --- |
+| `latest` | The most recent release, default when you don't select a version in particular. |
+| `develop` | The development branch - the next release as it is being written, with new features first and you contribute to testing the next version. |
+| A version number | That exact release, and the way to stay on a known version. |
+
+Versions are `major.minor.patch`, and each part can be used on its own to pin a specific "release channel" when upgrading:
+
+* [![major version](https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fapi.github.com%2Frepos%2Fa1ex4%2Fownfoil%2Freleases%2Flatest&search=%22tag_name%22%3A%5Cs%2A%22%28%5B0-9%5D%2B%29&replace=%241&label=)](https://github.com/a1ex4/ownfoil/releases/latest) is the `major` version, unlikely to change. Using it means the latest release of that major version.
+* [![minor version](https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fapi.github.com%2Frepos%2Fa1ex4%2Fownfoil%2Freleases%2Flatest&search=%22tag_name%22%3A%5Cs%2A%22%28%5B0-9%5D%2B%5C.%5B0-9%5D%2B%29&replace=%241&label=)](https://github.com/a1ex4/ownfoil/releases/latest) is the `minor` version, bumped when new features are introduced. Using it means the latest patch of that minor version, so including bug fixes but no new features.
+* [![patch version](https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fapi.github.com%2Frepos%2Fa1ex4%2Fownfoil%2Freleases%2Flatest&search=%22tag_name%22%3A%5Cs%2A%22%28%5B0-9%5D%2B%5C.%5B0-9%5D%2B%5C.%5B0-9%5D%2B%29&replace=%241&label=)](https://github.com/a1ex4/ownfoil/releases/latest) is the `patch` version, increased for a release that only fixes bugs in the latest minor version.
+
+Releases and what changed in them are on the [releases page](https://github.com/a1ex4/ownfoil/releases).
+
+## Docker
+
+The version is the image tag, `latest` when you don't set one:
+
+    docker run ... a1ex4/ownfoil:2.3
+
+In the compose file it is the `image` line:
+
+    image: a1ex4/ownfoil:develop
+
+Every branch of this repository is published under its own name too, i.e. `a1ex4/ownfoil:fix-something`, to test a fix before it is released.
+
+## uv
+
+Ownfoil is published on PyPI from `2.4.0` onwards, so a version is pinned like for any Python package:
+
+    uvx ownfoil@2.4.0
+    uv tool install ownfoil==2.4.0
+
+`develop` is not published there, install it from git instead:
+
+    uvx --from git+https://github.com/a1ex4/ownfoil@develop ownfoil
+    uv tool install git+https://github.com/a1ex4/ownfoil@develop

ownfoil-2.4.2/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.5
+Name: ownfoil
+Version: 2.4.2
+Summary: Self-hosted Nintendo Switch library manager, with automated management tasks, multi user authentication, serving your library to multiple supported clients on your Switch.
+Project-URL: Homepage, https://github.com/a1ex4/ownfoil
+Project-URL: Repository, https://github.com/a1ex4/ownfoil
+Project-URL: Issues, https://github.com/a1ex4/ownfoil/issues
+Author-email: a1ex4 <12754559+a1ex4@users.noreply.github.com>
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE.md
+Keywords: atmosphere,homebrew,nintendo-switch,self-hosted,switch,tinfoil
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.11
+Requires-Dist: flask-login==0.6.3
+Requires-Dist: flask-migrate==4.1.0
+Requires-Dist: flask-sock==0.7.0
+Requires-Dist: flask-sqlalchemy==3.1.1
+Requires-Dist: flask==3.1.3
+Requires-Dist: gunicorn==26.2.0; sys_platform != 'win32'
+Requires-Dist: nstools==2.0.0b7
+Requires-Dist: nsz==5.0.0
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: requests==2.34.2
+Requires-Dist: setproctitle==1.3.7
+Requires-Dist: strawberry-graphql[flask]==0.324.4
+Requires-Dist: watchdog==6.0.0
+Requires-Dist: werkzeug==3.1.8
+Requires-Dist: zstandard==0.25.0
+Description-Content-Type: text/markdown
+
+# <img src="https://github.com/user-attachments/assets/3cfdf010-50c3-41ae-aa86-e31b22466686" height="28"> Ownfoil
+[![Static Badge](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/a1ex4/ownfoil)
+[![Latest Release](https://img.shields.io/docker/v/a1ex4/ownfoil?sort=semver)](https://github.com/a1ex4/ownfoil/releases/latest)
+[![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/a1ex4/ownfoil?sort=date&arch=amd64)](https://hub.docker.com/r/a1ex4/ownfoil/tags)  
+[![Docker Pulls](https://img.shields.io/docker/pulls/a1ex4/ownfoil?)](https://hub.docker.com/r/a1ex4/ownfoil)
+[![Unraid downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fca.unraid.net%2Fapi%2Fsearch%3Fquery%3Downfoil%26type%3Ddocker&query=%24.hits%5B0%5D.chartData.totalDownloadsChart.data%5B6%5D&label=unraid%20downloads&color=F15A2C)](https://ca.unraid.net/apps/ownfoil-19wo90o0t5ul8s)  
+![Image archs](https://img.shields.io/badge/platforms-amd64%20%7C%20%20arm64%2Fv8%20%7C%20arm%2Fv7%20%7C%20arm%2Fv6-8A2BE2?style=flat-square)[![Nokia support](https://img.shields.io/badge/%7C%20Nokia%203310-8A2BE2?style=flat-square)](https://www.reddit.com/r/SwitchPirates/s/zy5ELiUW9y)  
+[![Tinfoil Version](https://img.shields.io/badge/Tinfoil-v20.0-da1c5c)](https://tinfoil.io/Download)
+[![Sphaira Version](https://img.shields.io/badge/Sphaira-v1.0.6-%233cd57a)](https://github.com/NaGaa95/sphaira)
+[![CyberFoil Version](https://img.shields.io/badge/CyberFoil-v1.4.5-firebrick)](https://github.com/luketanti/CyberFoil)
+
+
+Ownfoil is a Nintendo Switch library manager, that will also turn your library into a fully customizable and self-hosted Shop, supporting multiple clients. The goal of this project is to manage your library, identify any missing content (DLCs or updates) and provide a user friendly way to browse and install your content. Some of the features include:
+- multi user authentication
+- web interface for configuration and browsing the library
+- content identification using content decryption or filename
+- automatic library organization, verification and compression
+- console keys management
+- multiple clients support
+- shop customization
+
+# Installation
+
+Head over to [Install.md](./Install.md) for the full instructions:
+
+- [Using Docker](./Install.md#using-docker)
+- [Using uv (Windows users do this)](./Install.md#using-uv)
+- [Using Unraid](./Install.md#using-unraid)
+- [Using Proxmox LXC](./Install.md#using-proxmox-lxc)
+- [Using the Helm chart](./Install.md#using-the-helm-chart)
+
+> [!CAUTION]
+> There is __no website associated with this project__, only this GitHub repo.  
+> Ownfoil is __not released as an application or an executable file__ - DO NOT download or execute anything related to Ownfoil outside of this repository and its instructions.
+
+# Usage
+
+Configuring your shop, your clients and every setting available is documented in [Usage.md](./Usage.md). Start with [First steps](./Usage.md#first-steps), or jump straight to the [settings reference](./Usage.md#settings-reference).
+
+# Credits
+
+Thanks to the following projects and their maintainers for making Ownfoil possible:
+- [@blawar](https://github.com/blawar) for Tinfoil, Fs, the nsz format, TitleDB
+- [@nicoboss](https://github.com/nicoboss) for [nsz](https://github.com/nicoboss/nsz)
+- [@seiya-dev](https://github.com/seiya-dev) for [NSTools](https://github.com/seiya-dev/NSTools)

ownfoil-2.4.2/README.md

@@ -0,0 +1,45 @@
+# <img src="https://github.com/user-attachments/assets/3cfdf010-50c3-41ae-aa86-e31b22466686" height="28"> Ownfoil
+[![Static Badge](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/a1ex4/ownfoil)
+[![Latest Release](https://img.shields.io/docker/v/a1ex4/ownfoil?sort=semver)](https://github.com/a1ex4/ownfoil/releases/latest)
+[![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/a1ex4/ownfoil?sort=date&arch=amd64)](https://hub.docker.com/r/a1ex4/ownfoil/tags)  
+[![Docker Pulls](https://img.shields.io/docker/pulls/a1ex4/ownfoil?)](https://hub.docker.com/r/a1ex4/ownfoil)
+[![Unraid downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fca.unraid.net%2Fapi%2Fsearch%3Fquery%3Downfoil%26type%3Ddocker&query=%24.hits%5B0%5D.chartData.totalDownloadsChart.data%5B6%5D&label=unraid%20downloads&color=F15A2C)](https://ca.unraid.net/apps/ownfoil-19wo90o0t5ul8s)  
+![Image archs](https://img.shields.io/badge/platforms-amd64%20%7C%20%20arm64%2Fv8%20%7C%20arm%2Fv7%20%7C%20arm%2Fv6-8A2BE2?style=flat-square)[![Nokia support](https://img.shields.io/badge/%7C%20Nokia%203310-8A2BE2?style=flat-square)](https://www.reddit.com/r/SwitchPirates/s/zy5ELiUW9y)  
+[![Tinfoil Version](https://img.shields.io/badge/Tinfoil-v20.0-da1c5c)](https://tinfoil.io/Download)
+[![Sphaira Version](https://img.shields.io/badge/Sphaira-v1.0.6-%233cd57a)](https://github.com/NaGaa95/sphaira)
+[![CyberFoil Version](https://img.shields.io/badge/CyberFoil-v1.4.5-firebrick)](https://github.com/luketanti/CyberFoil)
+
+
+Ownfoil is a Nintendo Switch library manager, that will also turn your library into a fully customizable and self-hosted Shop, supporting multiple clients. The goal of this project is to manage your library, identify any missing content (DLCs or updates) and provide a user friendly way to browse and install your content. Some of the features include:
+- multi user authentication
+- web interface for configuration and browsing the library
+- content identification using content decryption or filename
+- automatic library organization, verification and compression
+- console keys management
+- multiple clients support
+- shop customization
+
+# Installation
+
+Head over to [Install.md](./Install.md) for the full instructions:
+
+- [Using Docker](./Install.md#using-docker)
+- [Using uv (Windows users do this)](./Install.md#using-uv)
+- [Using Unraid](./Install.md#using-unraid)
+- [Using Proxmox LXC](./Install.md#using-proxmox-lxc)
+- [Using the Helm chart](./Install.md#using-the-helm-chart)
+
+> [!CAUTION]
+> There is __no website associated with this project__, only this GitHub repo.  
+> Ownfoil is __not released as an application or an executable file__ - DO NOT download or execute anything related to Ownfoil outside of this repository and its instructions.
+
+# Usage
+
+Configuring your shop, your clients and every setting available is documented in [Usage.md](./Usage.md). Start with [First steps](./Usage.md#first-steps), or jump straight to the [settings reference](./Usage.md#settings-reference).
+
+# Credits
+
+Thanks to the following projects and their maintainers for making Ownfoil possible:
+- [@blawar](https://github.com/blawar) for Tinfoil, Fs, the nsz format, TitleDB
+- [@nicoboss](https://github.com/nicoboss) for [nsz](https://github.com/nicoboss/nsz)
+- [@seiya-dev](https://github.com/seiya-dev) for [NSTools](https://github.com/seiya-dev/NSTools)