update and add the docs from butter
This commit is contained in:
parent
fa3e971bb5
commit
3b0dabdfe8
138 changed files with 1164 additions and 586 deletions
8
www/docs/content-packs/apps/_category_.json
Normal file
8
www/docs/content-packs/apps/_category_.json
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"label": "Apps",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "content-packs/apps/index"
|
||||
}
|
||||
}
|
||||
143
www/docs/content-packs/apps/f-droid-repo.mdx
Normal file
143
www/docs/content-packs/apps/f-droid-repo.mdx
Normal file
|
|
@ -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
|
||||
```
|
||||
30
www/docs/content-packs/apps/index.mdx
Normal file
30
www/docs/content-packs/apps/index.mdx
Normal file
|
|
@ -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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue