add spanish
This commit is contained in:
n8fr8
parent
2ac53d2ebe
commit
4d86d9b7e8
29 changed files with 1141 additions and 0 deletions
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"label": "Content Packs",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "content-packs/index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"label": "Apps",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "content-packs/apps/index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,143 @@
|
|||
---
|
||||
description: How to Create Your Own F-Droid Repo to Share as a Content Pack
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# F-Droid Repo
|
||||
|
||||
You can build your own curated F-Droid repo using your computer's terminal. Once set up, users can connect their F-Droid app to your Butter Box and start downloading apps.
|
||||
|
||||
|
||||
|
||||
### Step 1: Install F-Droid Server Tools
|
||||
|
||||
Before you begin, you need to install a tool called **fdroidserver**. This helps you create and manage your app store.
|
||||
|
||||
**On Mac (using Homebrew):**
|
||||
|
||||
```
|
||||
brew install fdroidserver
|
||||
```
|
||||
|
||||
**On Linux (Debian/Ubuntu):**
|
||||
|
||||
```
|
||||
sudo apt install fdroidserver
|
||||
```
|
||||
|
||||
### Step 2: Check that it's installed correctly
|
||||
|
||||
After installation, run this command:
|
||||
|
||||
```
|
||||
fdroid version
|
||||
```
|
||||
|
||||
If everything is working, you will see a version number printed on the screen.
|
||||
|
||||
### Step 3: Create Your Repo Folder
|
||||
|
||||
You need to create the folder where you will save the repo files in your computer, choose a name that aligns with the project or purpose of the apps in it, and replace my-fdroid-repo for that name in the command.
|
||||
|
||||
```
|
||||
mkdir -p ~/my-fdroid-repo
|
||||
```
|
||||
|
||||
```
|
||||
cd ~/my-fdroid-repo
|
||||
```
|
||||
|
||||
### Step 4: Initialize the repo
|
||||
|
||||
```
|
||||
fdroid init
|
||||
```
|
||||
|
||||
This creates the following directories in your repo file:
|
||||
|
||||
```
|
||||
Config.yml
|
||||
```
|
||||
|
||||
```
|
||||
repo/
|
||||
```
|
||||
|
||||
```
|
||||
metadata/
|
||||
```
|
||||
|
||||
### Step 5: Add your APKs
|
||||
|
||||
Copy your signed APKs into the repo/ folder. Ensure you only use apps from trusted sources like the official F-Droid library or verified developers.
|
||||
|
||||
**Security Note:** Avoid downloading APKs from "mirror" sites or unknown sources, as they can contain malware or trackers that compromise your users' privacy.
|
||||
|
||||
```
|
||||
cp /path/to/your/*.apk repo/
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
cp ~/Downloads/myapp.apk repo/
|
||||
```
|
||||
|
||||
### Step 6: Generate (and Update) the Repository Index
|
||||
|
||||
Every time you add a new APK or a new version of an app to your repo/ folder, you must run the following command to "publish" those changes:
|
||||
|
||||
```
|
||||
fdroid update --create-metadata
|
||||
```
|
||||
|
||||
What this command does:
|
||||
|
||||
* **Scans APKs:** It reads the new files in your repo/ folder.
|
||||
* **Generates Metadata:** It creates YAML files containing the app's name, version, and permissions.
|
||||
* **Creates index.v1.jar:** This is the "catalog" file that the F-Droid app downloads to see what is available.
|
||||
* **Signs the Repository:** It uses your secret key to sign the index, proving to the Android app that the files haven't been tampered with.
|
||||
|
||||
### Step 7: Test your Repo locally
|
||||
|
||||
To test your repo locally and ensure everything works before you share it on the Butter Box, you can serve its content locally and add it to F-Droid using a URL.
|
||||
|
||||
```
|
||||
cd repo
|
||||
```
|
||||
|
||||
```
|
||||
python3 -m http.server 8000
|
||||
```
|
||||
|
||||
Once your repo is live, open the F-Droid app on your device and navigate to **Settings > Repositories > "+"**. Select **"Enter repository URL manually"** to add your new source.
|
||||
|
||||
Adding the repo manually allows you to verify the user experience by checking:
|
||||
|
||||
* **App Visibility:** Are all your apps appearing in the list?
|
||||
* **Visual Assets:** Are icons and screenshots displaying correctly?
|
||||
* **Categorization:** Are apps appearing in the correct sections (e.g., Internet, Security)?
|
||||
* **Functionality:** Do the downloads and installations complete without errors?
|
||||
* **Metadata:** Does the version number and description match your `repo/` files?
|
||||
|
||||
|
||||
|
||||
Your repo will be available at:
|
||||
|
||||
`http://YOUR-IP:8000/repo`
|
||||
|
||||
|
||||
|
||||
**Find your IP:**
|
||||
|
||||
#### macOS:
|
||||
|
||||
```
|
||||
ipconfig getifaddr en0
|
||||
```
|
||||
|
||||
#### Linux:
|
||||
|
||||
```
|
||||
hostname -I
|
||||
```
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Apps
|
||||
|
||||
You can share apps as a content pack, via a static website. If you give a folder the name `appstore` and place it in the root directory of the USB drive, the **Apps** tile will appear in the Butter Box portal.
|
||||
|
||||
**Things To Know**
|
||||
|
||||
* If you are sharing apps from Butter Box, you will need to download the app files you want to share. Apps are updated frequently. Be sure to manually update all of the app files frequently to ensure you are providing the highest security for the people who connect to the box.
|
||||
* You’ll need a copy of the app’s `.apk` file — make sure it’s from a safe and trusted source.
|
||||
* Butter won’t automatically verify the source, so it's up to you to confirm it's clean and legal to share.
|
||||
* How to get apk files: There are mobile apps you can use to get access to apk files on an Android phone. Alternatively, you can download app files directly from the developer's website.
|
||||
|
||||
### Go Further: Butter Box Supports Sharing Via F-Droid
|
||||
|
||||
Additionally, Butter Box supports app distribution via F-Droid. In your content pack, you can include the F-Droid `.apk` and a QR code for your repo. Anyone with access to the Box can then download the F-Droid app while offline, and add the repo.
|
||||
|
||||
As long as they are connected to the Butter Box, they can download any of the apps within your repo.
|
||||
|
||||
If they are connected to the internet later, they can receive app updates from any apps in your repo that are also included in the official F-Droid repo. If you update the apps in your repo, they will also have access to those.
|
||||
|
||||
What is a F-Ddroid Repo?
|
||||
|
||||
* A hosted library of apps\
|
||||
Why use it?
|
||||
* It offers a secure process for sharing apps. The F-Droid team builds apps in the official F-Droid repo from the source code themselves. This ensures that the app you download exactly matches the code the developer published.
|
||||
* Users installing from F-Droid have access to app updates remotely (away from the Butter Box)
|
||||
|
||||
Technical skills are required to create your own F-Droid repo. Refer to the [F-Droid Repo](f-droid-repo) Section for instructions.
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
description: Curated pluggable content
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Content Packs
|
||||
|
||||
You can create your own content pack! It simply needs to be set up as a **static website with local links**. This website will run from the box itself, so all of the images and files required for the website need to be contained within one main folder.
|
||||
|
||||
Once you have your static website ready, you will put all of the required files for it in one folder, and place this folder in the **root directory** of your USB drive. This website will be rendered in the browser people use to access the Butter Box portal.
|
||||
|
||||
Tips for creating a content pack with a static website:
|
||||
|
||||
* **Contents.** Everything for the static website must be stored on a USB drive that plugs into the Butter Box. It should not link to resources on the global internet.
|
||||
* **Size.** The size of your content pack is limited by the amount of space available on your USB drive. Though, keep in mind that if multiple people are downloading or watching really large files from the box, there may be some latency.
|
||||
* **Pages.** Links between pages should point to other saved pages in the same folder, not to the internet. You must use relative paths (e.g. about/index.html) instead of absolute web URLs.
|
||||
* **Media.** Pictures, videos, and sounds cannot be linked to from somewhere online. The files need to be in your website folder and stored on the USB drive.
|
||||
* **Libraries.** The website cannot use javascript libraries that rely on an internet connection.
|
||||
* **Styles.** Special fonts and icons (like those from Google Fonts) also need to be packed into the folder, not fetched from the web.
|
||||
|
||||
### Try It
|
||||
|
||||
* The zip file below contains a sample static website. To get a feel for how static websites work with butter—Download it. Unzip it. Then, add this set of files to your USB drive.
|
||||
|
||||
[Sample Static Website.zip](/img/docs/Sample Static Website.zip)
|
||||
|
||||
### Get Started
|
||||
|
||||
The best way to get started with creating your own content pack is to have an idea about the experience and type of information you want to provide, and then to design and build a local static website for it.
|
||||
|
||||
It can be very simple like an audio player for music. Or, a simple list of the five top VPN apps that you recommend. Or it can be more complex like a library or knowledge base of cultural artifacts.
|
||||
|
||||
|
||||
|
||||
### Add website files to a USB drive
|
||||
|
||||
Place a folder with your website files in the **root directory** of a USB drive. Be sure that your website folder contains your **index.html.** The name of this folder will be displayed on the Butter Box portal.
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2025-08-16 at 9.46.16 PM.png" alt=""/><figcaption><p>USB directory when viewed in Finder on desktop</p></figcaption></figure>
|
||||
|
||||
### Connect to your Butter Box to view
|
||||
|
||||
Insert the USB drive into your Butter Box. When you open the Butter Box portal, tap **Files**. Navigate to the website folder. Tap to view.
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Maps
|
||||
|
||||
You can make offline maps available from your Butter Box. These maps are powered by **OpenStreetMap (OSM)** and the **OsmAnd app** for Android.
|
||||
|
||||
:::warning
|
||||
**Important:** Offline map downloads work **only on Android devices**. iOS is not supported.
|
||||
:::
|
||||
|
||||
### ✅ Steps to Enable Maps
|
||||
|
||||
**1. Download the map files you need**
|
||||
|
||||
* Visit: [OsmAnd Local Indexes List](https://osmand.net/list?sortby=size\&asc=false)
|
||||
* Choose and download the regions you want available offline.
|
||||
|
||||
**2. Organize your files**
|
||||
|
||||
* On your USB drive, create a folder named `osm-map-files` .
|
||||
* Put the **OsmAnd APK** and all your **map files** into this folder.
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2025-08-16 at 9.44.40 PM.png" alt=""/><figcaption><p>USB directory when viewed in Finder on desktop</p></figcaption></figure>
|
||||
|
||||
**3. Add to your Butter Box**
|
||||
|
||||
* Insert the USB drive into your Butter Box.
|
||||
* The **Offline Maps** tile will automatically appear in your Butter Box portal.
|
||||
|
||||
👉 That’s it — anyone using an **Android device** can now download OsmAnd and the offline maps you’ve provided directly from your Butter Box.
|
||||
|
||||
Note: The OSM map apk is available on the Butter Box software image. Updates to the OsmAnd app will be available with new releases of the Butter Box software. If you want to know what the latest available version of OsmAnd app is, visit [OsmAnd Free Releases — Android](https://osmand.net/docs/versions/free-versions).
|
||||
Loading…
Add table
Add a link
Reference in a new issue