Ownfoil is a simple webserver aimed at running your own Tinfoil/Awoo shop from your local library, with full shop customisation and authentication. It is designed to periodically scan your library (default every 5 minutes), generate Tinfoil index file and serve it all over HTTP/S. This makes it easy to manage your library and have your personal collection available at any time.
Ownfoil can also be used to backup saves from multiple Switch devices, and make them available in your shop so you can use Tinfoil to reinstall them.
Why this project? I wanted a lightweight, dead simple, no dependancy and private personal Shop, without having to rely on other proprietary services (Google, 1fichier...) and having to maintain their implementation.
- Usage
- Configuration
- Shop Customization
- Setup Authentication
- Saves Manager
- Roadmap
- Changelog
- Similar Projects
Ownfoil is shipped as a Docker container for simplicity and compatibility. You first need to install Docker. Come back when you have a working installation!
Then, there are two ways to start the container, with docker run or docker-compose.
Use the PUID and PGID environment variables to make sure the app will have write access to your game directory.
Running this command will start the shop on port 8000 with the library in /your/game/directory :
docker run -d -p 8000:80 -v /your/game/directory:/games --name ownfoil a1ex4/ownfoil
The shop is now accessible with your computer/server IP and port, i.e. http://localhost:8000 from the same computer or http://192.168.1.100:8000 from a device in your network.
Create a file named docker-compose.yml with the following content:
version: "3"
services:
ownfoil:
container_name: ownfoil
image: a1ex4/ownfoil
environment:
# For write permission in /games directory
- PUID=1000
- PGID=1000
# Setup auth
- USERNAME=a1ex
- PASSWORD=pass
# - ROOT_DIR=/games
# - SAVE_ENABLED=true
volumes:
- /your/game/directory:/games
ports:
- "8000:80"
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.
In Tinfoil, add a shop with the following settings:
- Protocol:
http - Host: server/computer IP, i.e.
192.168.1.100 - Port: host port of the container, i.e.
8000 - Username: same as
USERNAMEenv if authentication is enabled - Password: same as
PASSWORDenv if authentication is enabled
On the first run of Ownfoil, a shop_config.toml file will be created in your games directory - use this file to configure different settings, like the scan interval.
All settings are described in the comments of the default configuration file.
Some settings can be overridden by using environment variables in the container, see here for the list.
All Tinfoil shop index keys are configurable - at the first run of Ownfoil, a shop_template.toml will be created in your games directory, just fill in the keys to customize your shop.
To enable shop authentication, simply define and set the USERNAME and PASSWORD environment variables inside the container. See the docker-compose example.
Ownfoil can be configured to backup saves from multiple Switch device and make them available in your shop, so that you can install them with Tinfoil. It uses FTP to periodically retrieve the saves.
Follow the guide below to enable an FTP server on your Switch and configure Ownfoil.
- Install sys-ftpd - available as
sys ftpd lightin the Homebrew Menu - Install ovl-sysmodule from Homebrew Menu - optional but recommended
Follow the sys-ftpd configuration to set up the user, password and port used for the FTP connection. Note these for Ownfoil configuration, as well as the IP of your Switch. If you installed ovl-sysmodule you can toggle on/off the FTP server using the Tesla overlay.
It is recommended to test the FTP connection at least once with a regular FTP Client to make sure everything is working as expected on the switch.
Using JKSV or Tinfoil (or any other saves manager), periodically extract your saves so that they can be retrieved by Ownfoil.
Note the folders where the saves are extracted. If you didn't change these settings, the default paths are:
- Tinfoil:
/switch/tinfoil/saves/common - JKSV:
/JKSV
In your shop configuration file, the save manager settings available are:
[saves]
# Enable or disable automatic saves backup
enabled = true
# Interval to retrieve saves, in minutes.
interval = 60
Make sure these settings are present if you are updating from a version < 1.2.0.
See the default shop default configuration file for a working configuration.
Then multiple switch can be configured, with the FTP connection details and saves directories to retrieve:
# Switches configuration for save retrieval.
# If user and pass are not specified, use anonymous connection
# Alex's Switch
[[saves.switches]]
host = "192.168.1.200"
port = "5000"
# user = "username"
# pass = "password"
folders = [
{local = "Saves/Tinfoil", remote = "/switch/tinfoil/saves/common"},
{local = "Saves/JKSV", remote = "/JKSV"}
]
The directories will be saved under your games directory so that the saves can be indexed by Ownfoil and made available in Tinfoil.
In the example above the Tinfoil saves will be saved under ./Saves/Tinfoil
Planned feature, in no particular order.
- Multi arch Docker image: currently supported platforms:
linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6 - Multiple user authentication
- Support emulator Roms
- Automatic nsp/xci -> nsz conversion
- Web UI
- list of available games/saves
- list of available updates/DLC not present on the shop, based on currently present games.
- operation on files
- Use a Python webserver framework instead of nginx
- ditch nginx
- dynamically set server config like auth, port
- Integrate torrent indexer Jackett to download updates automatically
- Saves manager: automatically discover Swicth device based on Tinfoil connection
- Saves manager: fixed multiple issues with remote folders (#42)
- Docker image: fix already existing user
- ci: Add automated multi arch docker build
- Add Saves manager to automatically backup and serve saves
- Setup base scheduler to periodically run jobs
- Fixes typo in run.sh script, fixes #5
- Container now support PUID/PGID to have the same permissions as the host user
- Rewrote Authentication setup to simplify it
- Switch to TOML for shop configuration and customization
- Fix shop.tfl generation: use path relative to the index file (fixes #1)
- Initial release
If you want to create your personal NSP Shop then check out these other similar projects: