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": "Build A Box",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "build-a-box/index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
description: DIY instructions
|
||||
---
|
||||
|
||||
# Build A Box
|
||||
|
||||
Don’t have a Butter Box yet? You can easily build your own. Choose your setup to get started.
|
||||
|
||||
## Butter Box Setups
|
||||
|
||||
Butter Box software currently runs on Raspberry Pi devices: Pi Zero 2 and Pi 4. You can use either one. See comparison chart below for details.
|
||||
|
||||
| Device | Capacity | Supplies |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------- |
|
||||
| <p><strong>Basic</strong> </p><p>Raspberry Pi Zero Pi 2<br/><br/><a href="raspberry-pi/basic-box-supplies">Get Started</a></p> | Up to 10 people, About 10 meters apart | [Supply List](raspberry-pi/basic-box-supplies) |
|
||||
| <p><strong>Extended</strong> </p><p>Raspberry Pi 4 + Router<br/><br/><a href="raspberry-pi/extend-your-box">Get Started</a></p> | Up to 20 people, About 30 meters apart when paired with a router | [Supply List](raspberry-pi/extend-your-box) |
|
||||
| PC/Laptop (amd64) | _Coming soon_ | _Coming soon_ |
|
||||
|
||||
We also make and ship Butter Boxes to partners worldwide. If you serve a community that could benefit, we’d love to hear from you.
|
||||
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
description: How to turn an old PC into golden deliciuos butter!
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# PC/Laptop Support (BETA!)
|
||||
|
||||
An important new development for the ButterBox project is the ability to turn any Intel or AMD 64-bit PC into a ButterBox. In many places in the world, getting access to an official RaspberryPi is difficult and expensive. However, no matter where you are in the world, there seem to be plenty of "old", unloved, discarded PC towers and laptops.
|
||||
|
||||
This page will help you bring new life to that old tech, by turning it into the best kind of buttery local microserver, that even has a built-in battery, screen and keyboard!
|
||||
|
||||
## Download the Image
|
||||
|
||||
Access to new images of ButterBox built for Intel/AMD64 devices are now available IN EARLY BETA through our [development image distribution site](https://files.sr2.uk/d/52bd8561a10d4d83be7b/?p=%2F&mode=list). Download the latest image that beings with "amd64_butter_main_".
|
||||
|
||||
## How to Flash
|
||||
|
||||
This image can be flashed to a bootable USB drives, using [balenaEtcher](https://etcher.balena.io/).
|
||||
|
||||
1. Install balenaEtcher
|
||||
2. Download the AMD64 image and unpack it (remove .tar and .gz with "unzip" tool)
|
||||
3. Select the image file in balenaEtcher
|
||||
4. Plugin the USB flash drive
|
||||
5. Select the drive in balenaEtcher
|
||||
6. Flash!
|
||||
|
||||
## How to Boot Up
|
||||
|
||||
Once the USB drive is flashed, you can now use it to boot up ButterBox on your old PC.
|
||||
|
||||
1. Boot your old PC into the "BIOS" screen. Make sure it is configured to allow for booting from the USB drive, before it boots the internal hard drive.
|
||||
2. Shutdown the PC.
|
||||
3. Plug in the USB drive to the PC
|
||||
4. Start the PC, and make sure it boots from the USB drive.
|
||||
5. Wait for the login terminal to appear!
|
||||
|
||||
## How to Access
|
||||
|
||||
Once the ButterBox PC is booted up, and plugged into a local router, it should be ready to access!
|
||||
|
||||
Connect your personal device to the same network, and try to access [http://butterbox.local](http://butterbox.local)
|
||||
|
||||
## Differences from RaspberryPi edition
|
||||
|
||||
There are some important differences between ButterBox on PC versus on RaspberryPi
|
||||
|
||||
- There is no built-in wifi hotspot. You must plug it into a dedicated wifi router or network.
|
||||
- You can easily access the terminal "root" user to update and configured (with great power, comes great responsibility!)
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
description: Different ways to power your Butter Box
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Power Supply
|
||||
|
||||
If you want Butter to work completely off-grid and without electricity, it can! Butter Boxes can be powered by a wall outlet, pre-charged battery pack or solar powered battery pack.
|
||||
|
||||
* **Wall Outlet:** The official and recommended power supply for Raspberry Pi computers (depends of the Raspberry Pi model that you are using)
|
||||
* **Pre-charged Battery Pack (Power Bank):** This is the most common option for field use.
|
||||
* Anker portable charger [power bank](https://www.amazon.com/Anker-Portable-PowerCore-High-Speed-Charging/dp/B09VXF29RM/ref=sr_1_6?crid=30EJM6E540GE6\&dib=eyJ2IjoiMSJ9.cMM86su3KXjp8lN7z7mvmL1HERSowjwoegVu1E_8xhH-Pl38rDD2hEv21fVqk-w2eogpdZGsfiLn_V8ij-PvaRw3RDBdv9-NTKTFqGOUj6IZJKMdbeUjGkgBFVFdZvyOkBFF6kau0uJIE-rRQyseWiNNPxZwan-29xuz2_f643gTOfOzERBuVK2cDdpm91rPdVsRl3dKy6iR1K7qkYW5YGTtYpaZWriYGWOovD2CcVA.SogXwrCYRlPyAkf0wzwye8_-ZdVw-Fi0EcM5vcr7ESk\&dib_tag=se\&keywords=anker%2Bpower%2Bbank%2Bbattery%2Bpack%2Bwhite\&qid=1756265405\&sprefix=anker%2Bpower%2Bbank%2Bbattery%2Bpack%2Bwhit%2Caps%2C154\&sr=8-6\&th=1)
|
||||
* **Solar Panel (with Power Bank):** Use a small solar panel to recharge your power bank. This is a good option to keep the box running continuously in off-grid locations. Using direct solar panel without a battery is possible, but unstable if the sun dips in/out.
|
||||
* Solar panel kits: [https://voltaicsystems.com/solar-panel-kits/](https://voltaicsystems.com/solar-panel-kits/)
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2025-07-31 at 10.55.41 PM.png" alt=""/><figcaption></figcaption></figure>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"label": "Raspberry Pi",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "build-a-box/raspberry-pi/index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Basic Box Supplies
|
||||
|
||||
A basic Butter Box setup is a Raspberry Pi Zero 2 W with a microSD card running the Butter software, a USB stick, powered by a USB source like a power cord, power bank or solar panel.
|
||||
|
||||
In most setups like this, a Butter Box can comfortably handle **4–10 connected devices at once** without slowing down. It’s possible to have more, but performance may drop if everyone is downloading large files or videos at the same time.
|
||||
|
||||
The reach for it is about **5–10 meters** indoors, depending on the Raspberry Pi model and depending on walls and interference. Outdoors, in open space, it can sometimes reach farther. Think of it like the range of a home Wi-Fi router — enough to cover a classroom, a coffee shop, meeting space, or small outdoor gathering.
|
||||
|
||||
## Supplies
|
||||
|
||||
* [ ] Raspberry Pi Zero 2W (64 Bit) [https://www.adafruit.com/product/5291](https://www.adafruit.com/product/5291); Or you can buy a kit here: [\
|
||||
https://www.canakit.com/raspberry-pi-zero-2-w.html](https://www.canakit.com/raspberry-pi-zero-2-w.html)
|
||||
* [ ] Power outlet and power cord that accompanies the Raspberry Pi Zero 2W or an [alternative power supply](../power-supply)
|
||||
* [ ] Micro SD Card: Images with the Butter software are usually under 16 GB (we suggest 256 GB). Media that people upload to the chat ends up on the card; it never gets cleared.
|
||||
* [ ] USB drive (min 32 GB)
|
||||
* [ ] Adapters (as needed)
|
||||
|
||||
* [ ] Micro USB/Male to USB A/Female
|
||||
* [ ] A dongle to connect the micro SD card to your laptop (if needed)
|
||||
|
||||
|
||||
|
||||
**Once you have your supplies, continue in the Install Butter section.**
|
||||
|
||||
[install-butter.md](install-butter)
|
||||
|
||||
<figure><img src="/img/docs/20250815_142828.jpg" alt=""/><figcaption></figcaption></figure>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
description: How To Add a Router To Your Box Setup
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Extend Your Box
|
||||
|
||||
An extended Butter Box pairs the Raspberry Pi with a standalone Wi-Fi router, giving stronger signal and more simultaneous connections.
|
||||
|
||||
With the router, the network can reach 10-30 m (32-98 feet),and can comfortably support 10–20 connected devices at the same time. This setup is ideal for a medium group of people in a medium room, like classrooms, events, or community spaces.
|
||||
|
||||
## Supplies
|
||||
|
||||
* [ ] Raspberry Pi 4, 5 or Raspberry Pi Zero 2W
|
||||
* [ ] Router ([Opal (GL-SFT1200) Wireless Travel Router](https://store-us.gl-inet.com/products/united-states-opal-gl-sft1200-gigabit-wireless-router-dual-band-openwrt-ipv6-tor) or equivilent)
|
||||
* [ ] Power outlet and power cords that accompany the Raspberry Pi and the Router or an [alternative power supply](../power-supply)
|
||||
* [ ] Micro SD Card: Images with the Butter software are usually under 16 GB (we suggest 256 GB). Media that people upload to the chat ends up on the card; it never gets cleared.
|
||||
* [ ] USB Drive (min 32 GB)
|
||||
* [ ] Adapters (as needed)
|
||||
|
||||
_No internet connection is required._
|
||||
|
||||
<figure><img src="/img/docs/20250815_142438.jpg" alt=""/><figcaption></figcaption></figure>
|
||||
|
||||
|
||||
|
||||
## Steps
|
||||
|
||||
To extend your box, you simply connect a GLi-Net router to the Butter Box with an ethernet cable. Instead of accessing the box from the portal Wi-Fi hotspot (eg. 'butter box' or whichever name you set in the admin settings), users will join the Wi-Fi network of the router.
|
||||
|
||||
### Connect the Butter Box to its power supply.
|
||||
|
||||
Connect the Butter Box to power.
|
||||
|
||||
### Connect Router
|
||||
|
||||
Connect the router to power. Then use the ethernet cable to connect to the Butter Box. Make sure to plug the Ethernet cable into the LAN port on your router.
|
||||
|
||||
### Test Your Connection
|
||||
|
||||
Join the router Wi-Fi. If you have not setup or used this router before, enter the default password found in the user guide included in the package. After 30 seconds, open http://butterbox.local in a browser.
|
||||
|
||||
### Disable Butter Box Wi-Fi Access Point
|
||||
|
||||
Open the admin settings from the Butter Box portal. Navigate to **Secure Portal**. Turn off the Wi-Fi access point. This will hide the Wi-Fi network that broadcasts from the raspberry pi, so that users don’t get confused about which network to join.
|
||||
|
||||
### Invite Users to Join the Router Wi-Fi
|
||||
|
||||
Users will now join the Wi-Fi network of the router when they want to connect to the Butter Box.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Raspberry Pi
|
||||
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
---
|
||||
description: Install Butter Operating System (OS) on an SD card for Raspberry Pi
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Install Butter
|
||||
|
||||
You will need:
|
||||
|
||||
* Desktop computer
|
||||
* Internet Connection
|
||||
* Butter Box
|
||||
|
||||
### Download the Butter OS for Raspberry Pi
|
||||
|
||||
Make sure the file size matches the size listed on the website. Sometimes browsers do not complete the download, which can result in a corrupted file.
|
||||
|
||||
[https://www.dropbox.com/scl/fo/helpqh3q2oj7ti2ia038m/h?dl=0.&rlkey=cswt4w4zksiuj3eb1oca48yw0](https://www.dropbox.com/scl/fo/helpqh3q2oj7ti2ia038m/h?dl=0.&rlkey=cswt4w4zksiuj3eb1oca48yw0)
|
||||
|
||||
:::info
|
||||
Always choose the Latest Version of the file.
|
||||
:::
|
||||
|
||||
### Plug the micro SD card into your computer
|
||||
|
||||
To plug the micro SD card into your computer, you may need an adapter to do this:
|
||||
|
||||
<div align="center"><figure><img src="/img/docs/image (1).png" alt="" width="375"/><figcaption><p>Example adapter (USB-C to Micro SD)</p></figcaption></figure></div>
|
||||
|
||||
:::info
|
||||
You don't need to connect the box to the computer.
|
||||
:::
|
||||
|
||||
### Run Raspberry Pi Imager
|
||||
|
||||
Once you have your micro SD card plugged into your computer that has an internet connection, run Raspberry Pi Imager from a desktop computer. It will walk you through the steps to install the Butter operating system on the micro SD card.
|
||||
|
||||
If you don't have Raspberry Pi Imager, you can download it here: [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/)
|
||||
|
||||
### Choose device > **Raspberry Pi Zero 2 W**
|
||||
|
||||
Once the Raspberry Pi Image starts, you will be prompt to select your Raspberry Pi device.
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2026-02-24 at 9.56.27 AM.png" alt=""/><figcaption><p>Select Raspberry Pi Zero 2 W (or the device you have if it's not the standard box from Butter HQ)</p></figcaption></figure>
|
||||
|
||||
### Choose Operating System > Use Custom
|
||||
|
||||
* On the OS tab, select **Use custom** and upload the custom Butter OS .img file. Confirm that you have **unzipped the file** before using it.
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2026-02-24 at 9.57.31 AM.png" alt=""/><figcaption><p>Select Use Custom. You will upload the custom .img file that you downloaded from Dropbox.</p></figcaption></figure>
|
||||
|
||||
### Choose Storage > Select Micro SD Card
|
||||
|
||||
* From the **Storage** tab, select the **Micro SD Card.**
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2026-02-24 at 1.27.37 PM.png" alt=""/><figcaption><p>Select the Micro SD Card.</p></figcaption></figure>
|
||||
|
||||
Your screen will look similar to this after all selections:
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2026-02-24 at 1.27.43 PM.png" alt=""/><figcaption><p>Final screen after selections.</p></figcaption></figure>
|
||||
|
||||
You may be prompt with _"Doing this will erase all data from selected external storage"_ and “_do you want to apply settings”_, click then on _“no clear settings”_.
|
||||
|
||||
After that select _"write"_ and begin writing process to the Micro SD card.
|
||||
|
||||
### Remove From Computer and Insert Micro SD Card into the Raspberry Pi (Butter Box)
|
||||
|
||||
Once you're done, remove the Micro SD card. Insert the Micro SD card into the Raspberry Pi (Butter Box) not powered on.
|
||||
|
||||
### Go to Quick Start
|
||||
|
||||
Plug the Raspberry Pi (Butter Box) into power. Wait a few moments and connect to the Butter Box Portal. Go to the [Quick Start](../../quick-start) section for more details.
|
||||
|
||||
**If you are building an extended box, continue in the next section: Extend Your Box.**
|
||||
|
||||
[extend-your-box.md](extend-your-box)
|
||||
|
||||
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
If you see an error stating that the input file is not a valid disk image, check the file you downloaded.
|
||||
|
||||
Make sure the file size matches the size listed on the website. Sometimes browsers do not complete the download, which can result in a corrupted file.
|
||||
|
||||
Also confirm that you have **unzipped the file** before using it.
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2026-02-24 at 1.28.37 PM.png" alt=""/><figcaption></figcaption></figure>
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
description: Different ways to power your Butter Box
|
||||
---
|
||||
|
||||
# Power Supply
|
||||
|
||||
If you want Butter to work completely off-grid and without electricity, it can! Butter Boxes can be powered by a wall outlet, pre-charged battery pack or solar powered battery pack.
|
||||
|
||||
* **Wall Outlet:** The official and recommended power supply for Raspberry Pi computers (depends of the Raspberry Pi model that you are using)
|
||||
* **Pre-charged Battery Pack (Power Bank):** This is the most common option for field use.
|
||||
* Anker portable charger [power bank](https://www.amazon.com/Anker-Portable-PowerCore-High-Speed-Charging/dp/B09VXF29RM/ref=sr_1_6?crid=30EJM6E540GE6\&dib=eyJ2IjoiMSJ9.cMM86su3KXjp8lN7z7mvmL1HERSowjwoegVu1E_8xhH-Pl38rDD2hEv21fVqk-w2eogpdZGsfiLn_V8ij-PvaRw3RDBdv9-NTKTFqGOUj6IZJKMdbeUjGkgBFVFdZvyOkBFF6kau0uJIE-rRQyseWiNNPxZwan-29xuz2_f643gTOfOzERBuVK2cDdpm91rPdVsRl3dKy6iR1K7qkYW5YGTtYpaZWriYGWOovD2CcVA.SogXwrCYRlPyAkf0wzwye8_-ZdVw-Fi0EcM5vcr7ESk\&dib_tag=se\&keywords=anker%2Bpower%2Bbank%2Bbattery%2Bpack%2Bwhite\&qid=1756265405\&sprefix=anker%2Bpower%2Bbank%2Bbattery%2Bpack%2Bwhit%2Caps%2C154\&sr=8-6\&th=1)
|
||||
* **Solar Panel (with Power Bank):** Use a small solar panel to recharge your power bank. This is a good option to keep the box running continuously in off-grid locations. Using direct solar panel without a battery is possible, but unstable if the sun dips in/out.
|
||||
* Solar panel kits: [https://voltaicsystems.com/solar-panel-kits/](https://voltaicsystems.com/solar-panel-kits/)
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2025-07-31 at 10.55.41 PM.png" alt=""/><figcaption></figcaption></figure>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
# Use Cases
|
||||
|
||||
### 1. Digital Security training to distribute apps and materials
|
||||
|
||||
> Leaders from Southern Africa countries travel to provide training, audits, and consultations to organizations about digital security, physical safety, risk assessments, and to equip journalists, activists and human rights defenders with the tools and knowledge to do their job safer. In order to do their work effectively, these leaders need to be able to curate specific types of content to fit various use cases, in different contexts and languages and different formats. In offline situations (load shedding, no access to the internet or in times of internet shutdowns) the ability to successfully deliver trainings and content becomes almost impossible. \
|
||||
> \
|
||||
> They shared more than a few times that if they did not have the Butter Box, some sessions would have been canceled.
|
||||
|
||||
### 2. Sharing & Media Backup
|
||||
|
||||
> Often M. wants to share music and movie files that they’ve downloaded on their computer with their friends — but transferring with cables or Bluetooth is a pain. So they've set up a Butter Box with their media collection — music files, films and photos. They plugged it in near the kitchen, and now anyone in their apartment can connect to the Butter Wi‑Fi and browse a shared media library. No internet needed, and no more file-by-file transfers.
|
||||
|
||||
### 3. Temporary file storage
|
||||
|
||||
> On a remote site with no cell service, workers needed a way to temporarily offload large files — like site photos or documents — from their phones. Using Butter Box’s local encrypted message board, they sent files to themselves or coworkers for safekeeping. Files stayed on the device until retrieved later, even without power or signal.
|
||||
|
|
@ -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).
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"label": "FAQ",
|
||||
"position": 8,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "faq/index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# How to Reformat Your USB Drive
|
||||
|
||||
After connecting your USB drive to the Raspberry Pi you will see the “Explore USB” title displayed on the portal. If you’ve tried refreshing your portal page and still do not see the “Explore USB” tile then you may need to erase your USB stick and reformat it.
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
When you format a USB drive, all files and folders on the drive are removed and replaced with a new file system. This can help repair any issues with the flash drive itself or make it compatible with new files you want to transfer. Be sure to back up your files before formatting your drive. <br/>
|
||||
|
||||
**Check the Format of the USB**
|
||||
|
||||
* On your desktop or laptop, plug in your USB
|
||||
* Right, or double-click on the USB
|
||||
* Click on “Get info” and verify the Format
|
||||
* Your USB needs to be formatted to ExFat or Fat32, MS-DOS (FAT).
|
||||
|
||||
|
||||
|
||||
**Reformatting Steps on MacOS:**
|
||||
|
||||
* Connect the USB drive to a USB port on your computer.
|
||||
* Right, or double-click on the USB
|
||||
* Click on “Erase Disk…”
|
||||
* You can rename your USB at this time
|
||||
* Select the correct format, either ExFat or ExFat32 or MS-DOS (FAT)
|
||||
* Then tap “Erase”
|
||||
* A message may appear warning you that all content will be deleted. Select “Erase”
|
||||
* This may take a few minutes. The USB will disappear and reappear on your homescreen
|
||||
* Verify the drive is correctly formatted
|
||||
* Right, or double-click on the USB
|
||||
* Click on “Get info” and verify the Format<br/>
|
||||
|
||||
**Reformatting Steps on Windows:**
|
||||
|
||||
* Connect the USB drive to a USB port on your computer.
|
||||
* Open the File Explorer and select "This PC" from the menu.
|
||||
* You can find this option in the left panel, next to a monitor icon.[\[2\]](https://www.wikihow.com/Format-a-Flash-Drive#_note-2)
|
||||
* On Windows 7, click Computer on the right side of the Start window.
|
||||
* Right-click the flash drive's icon. It's beneath the "Devices and drives" heading in the middle of the page. This will bring up a drop-down menu.
|
||||
* Choose "Format". This will open the formatting window.
|
||||
* Click on "File System" and choose the MS-DOS, FAT32, or exFAT format.
|
||||
* [FAT32](https://www.wikihow.com/Format-FAT32) - The most widely compatible format. Works with most computers and gaming consoles.
|
||||
* exFAT - Similar to FAT32, but designed for external hard drives (e.g., flash drives) and quicker use. It's a universal format that is most common across Windows, Linux, and Mac.
|
||||
* Select "Start" and click "OK" to finish formatting your flash drive.
|
||||
* A final prompt will appear, Click “OK”. Your flash drive has successfully been formatted.<br/>
|
||||
|
||||
.png>).png>).png>)
|
||||
|
||||
.png>)
|
||||
|
||||
.png>)
|
||||
|
||||
<br/>
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# FAQ
|
||||
|
||||
### Does the Butter Box give me the internet?
|
||||
|
||||
Not quite. The Butter Box doesn’t provide internet access. Instead, it creates its own local Wi-Fi network that lets you access apps, content (previously set up), and message board features offline . Everything is stored and shared locally — no internet or data connection needed.
|
||||
|
||||
***
|
||||
|
||||
### How do you power a Butter Box?
|
||||
|
||||
The Butter Box is super flexible! You can power it using a USB power bank, a wall adapter, or even a small solar panel. As long as it provides power to the Raspberry Pi, you’re good to go. Go to the [Power Supply](../build-a-box/power-supply) section to learn more.
|
||||
|
||||
***
|
||||
|
||||
### If I’m powering the Butter Box with a solar panel, do I need a power bank?
|
||||
|
||||
A power bank isn’t strictly required, but it’s highly recommended. Solar panels can be inconsistent — clouds, shade, or changing sunlight can interrupt power. A power bank helps smooth that out by storing energy and keeping the Butter Box running steadily, even when sunlight dips. Check it out this use case to know more: (insert use case URL)
|
||||
|
||||
***
|
||||
|
||||
### What are the security features of the Butter Box? Can I put a password on it?
|
||||
|
||||
Currently, the Butter Box broadcasts an open Wi-Fi network — that means no password is required to connect. This makes it easy for people nearby to join, especially in offline or community settings.
|
||||
|
||||
However, users must either enter the Butter Box’s local IP address manually, or scan a QR code that takes them directly to the content. Since it’s all offline, there’s no exposure to the internet or external threats.
|
||||
|
||||
You can configure the Raspberry Pi to require a Wi-Fi password in the admin settings. Refer to the [Security](../security) section for more security features.
|
||||
|
||||
***
|
||||
|
||||
### How much storage does a Butter Box have?
|
||||
|
||||
The Butter Box storage capacity is defined by the microSD card you install — it doesn’t have fixed built-in memory. You can choose anything from a 16 GB card up to 1 TB (the Raspberry Pi Zero 2 W supports microSD sizes up to that). We recommend 256 GB.
|
||||
|
||||
| Use Case | Suggested micro SD Size |
|
||||
| ------------------------------------- | -------------------------- |
|
||||
| Basic setup (apps + message board) | 16 GB – 32 GB |
|
||||
| Additional content or media storage | 64 GB – 128 GB |
|
||||
| Handling large content packs or files | 256 GB or more, up to 1 TB |
|
||||
|
||||
***
|
||||
|
||||
### Can I customize it?
|
||||
|
||||
Absolutely! You can add, for example, your own content - dropping in PDFs, videos, images, and HTML pages to build a local library, or add your own apps - including Android APKs (even if they’re not on F-Droid).
|
||||
|
||||
***
|
||||
|
||||
### My USB drive is plugged into the Butter Box, but the content is not displayed on the portal. Why?
|
||||
|
||||
Yout USB drive is probably in the wrong format. Your USB needs to be formatted to ExFat, Fat32, MS-DOS (FAT). Refer to [Reformatting Your USB](how-to-reformat-your-usb-drive) for help.
|
||||
15
www/i18n/es/docusaurus-plugin-content-docs/current/index.mdx
Normal file
15
www/i18n/es/docusaurus-plugin-content-docs/current/index.mdx
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
description: Sharing offline has never been easier!
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Comenzar
|
||||
|
||||
Butter Box es un dispositivo ligero y portátil que funciona como un disco duro con su propio punto de acceso (hotspot). Cualquier persona cercana puede conectarse a él y ver o descargar su contenido, sin necesidad de internet.
|
||||
|
||||
Ya sea que tengas un Butter Box en tus manos o necesites construir uno, estás en el lugar indicado. Elige una opción a continuación.
|
||||
|
||||
<table data-view="cards"><thead><tr><th></th><th data-type="content-ref"></th></tr></thead><tbody><tr><td>I Have A Box</td><td><a href="quick-start">quick-start.md</a></td></tr><tr><td>I Need A Box</td><td><a href="build-a-box/">build-a-box</a></td></tr></tbody></table>
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Quick Start
|
||||
|
||||
If you have a Butter Box with the latest version of the Butter software loaded on the SD card, take these quick steps to get set up.
|
||||
|
||||
### Check supplies
|
||||
|
||||
Make sure you have the supplies for a basic box:
|
||||
|
||||
* [ ] Power source
|
||||
* [ ] USB drive
|
||||
* [ ] USB Adapters (as needed)
|
||||
* [ ] Butter Box Device (with micro SD card inserted)
|
||||
* [ ] Case
|
||||
|
||||
<figure><img src="/img/docs/signal-2025-08-21-140334_003.jpeg" alt=""/><figcaption></figcaption></figure>
|
||||
|
||||
### Make sure the micro SD card is inserted into the device
|
||||
|
||||
The micro SD card should have the latest version of Butter OS running on it.
|
||||
|
||||
### Plug it in to power on
|
||||
|
||||
Connect the power supply to the first micro USB port and correct wall outlet.
|
||||
|
||||
<figure><img src="/img/docs/1.png" alt="" width="375"/><figcaption></figcaption></figure>
|
||||
|
||||
You will know the box is working if ‘butterbox’ wifi appears in the wifi list on your phone or computer. If it doesn’t, unplug the box and plug it back in.
|
||||
|
||||
|
||||
|
||||
_If using a solar battery or other means of power, use one with the correct specs to ensure adequate power and avoid damage to the unit. For a Pi Zero 2 W use Micro USB power supply with at least 2.0A._
|
||||
|
||||
[Link to Power Supply Options](build-a-box/power-supply)
|
||||
|
||||
|
||||
|
||||
### Insert USB drive
|
||||
|
||||
Connect the USB adapter to the open port. Then plug in the USB drive. Learn more about loading the USB drive with treasures in the [File Sharing](services/file-sharing) section.
|
||||
|
||||
<figure><img src="/img/docs/2.png" alt="" width="375"/><figcaption></figcaption></figure>
|
||||
|
||||
### Access the Butter Box Portal
|
||||
|
||||
Join the ‘butterbox’ Wi-Fi. After 30 seconds, scan the QR code on the box. This connects you to **http://butterbox.local** in a browser.
|
||||
|
||||
[https://youtu.be/KB5O9MSoaAg](https://youtu.be/KB5O9MSoaAg)
|
||||
|
||||
<div align="center"><figure><img src="/img/docs/qr code.png" alt="" width="375"/><figcaption></figcaption></figure></div>
|
||||
|
||||
_If this page does not load, wait a few minutes to ensure connectivity. Refresh the page. If you’re connecting from a smartphone, turn off your mobile data or turn on airplane mode. Then try again._
|
||||
|
||||
:::info
|
||||
This is an HTTP page, not HTTPS, because it's served from a local device with no internet connection. Your data never leaves the network, so it's still private and secure.
|
||||
:::
|
||||
|
||||
The Wi-Fi does not have a password by default. Though, you can easily add one in the Admin Settings.
|
||||
|
||||
### Once connected, use Admin Settings to set up your box.
|
||||
|
||||
The admin setup wizard is designed to give you choice over which services are offered on the box and to increase its security. You will be prompted to go to Admin Settings if this is the first time you've used the box.
|
||||
|
||||
### Share access to the portal
|
||||
|
||||
Once you share with others, they will connect to it in the same way you just did.
|
||||
|
||||
:::info
|
||||
For a Pi Zero 2 W: Up to 5 people can connect to the box at any time. After people connect and get what they need, encourage them to leave the box to give others a turn.\
|
||||
The physical reach of the Box varies. But as a rule of thumb, people in the same room as the box (or in talking distance) will be able to access it.
|
||||
:::
|
||||
170
www/i18n/es/docusaurus-plugin-content-docs/current/security.mdx
Normal file
170
www/i18n/es/docusaurus-plugin-content-docs/current/security.mdx
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
---
|
||||
description: How to Make a Butter Box Tamper Resistant
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Security
|
||||
|
||||
This guide was designed for deployments in hostile, semi-hostile, or low-trust environments, where devices may be inspected, confiscated, modified, or misused. It aims to provide practical recommendations to make the Butter Box more physically and digitally tamper-resistant.
|
||||
|
||||
Following the recommendations in this guide will help reduce risk, not guarantee absolute security. Butter Box is assumed to be a field-deployable, low-cost, offline system, so these recommendations prioritize realistic, maintainable protections.
|
||||
|
||||
**Threat Model Assumptions**
|
||||
|
||||
Before applying controls, clearly define your deployment context. This guide assumes one or more of the following risks:
|
||||
|
||||
* Physical access by unauthorized users
|
||||
* Device confiscation or inspection by authorities
|
||||
* Curious or malicious local users
|
||||
* Content manipulation or replacement
|
||||
* Network misuse or impersonation
|
||||
* Credential reuse or default configuration abuse
|
||||
|
||||
Remember that controls should adapt to the local risk level, over-hardening can reduce usability and trust.
|
||||
|
||||
|
||||
|
||||
### Section 1: Physical Tamper Resistance
|
||||
|
||||
#### Enclosure and Hardware Protection
|
||||
|
||||
Physical access to the Butter Box allows SD card cloning, firmware replacement, malware injection and broadcasting of malicious information. PCB are also delicate and should have additional protection to keep them safe from everyday handling and weather exposure.
|
||||
|
||||
Recommendations:
|
||||
|
||||
1. Use a sealed or semi-sealed enclosure (screws instead of snap-fit)
|
||||
2. Prefer tamper-evident screws (Torx, security hex)
|
||||
3. Apply tamper-evident stickers over enclosure seams and SD card slots
|
||||
|
||||
| 1) Sealed enclosures | 2) Screws |
|
||||
| --------------------------------- | --------------------------------------- |
|
||||
|  | .jpeg>) |
|
||||
|
||||
#### 
|
||||
|
||||
#### SD Card & Storage Protection
|
||||
|
||||
Recommendations:
|
||||
|
||||
1. Use high-quality SD cards to reduce corruption
|
||||
2. Encrypt sensitive partitions (where feasible)
|
||||
3. Keep content and OS separated (firmware vs content packs)
|
||||
4. Avoid labeling SD cards with sensitive identifiers
|
||||
|
||||
Optional (higher risk contexts):
|
||||
|
||||
1. Epoxy Resin. Electronico potting solutions protect Printed Circuit Boards from extreme temperatures, moisture, vibration, and other environmental threats.
|
||||
2. Physically block SD card removal
|
||||
|
||||
|
||||
|
||||
| Epoxy Resin | Epoxy Resin |
|
||||
| --------------------------------------- | --------------------------------------- |
|
||||
| .jpeg>) | .jpeg>) |
|
||||
|
||||
#### .jpeg>)
|
||||
|
||||
#### Power & Port Management
|
||||
|
||||
Recommendations:
|
||||
|
||||
1. Disable or physically block unused ports (USB, HDMI). Inexpensive physical port blockers can be used to reduce the risk of tampering with the Butter Box by preventing unauthorized access to exposed interfaces. These blockers limit the ability of bad actors to inject malicious code, connect unauthorized peripherals, or broadcast unwanted content. Ports are sealed with plastic blockers that can only be removed using a dedicated key included in the deployment kit.
|
||||
2. Avoid exposing Ethernet ports unless required. Ethernet ports should remain disabled or physically blocked unless they are explicitly required for the deployment. When Ethernet access is necessary, its use should be clearly documented and limited to trusted operators.
|
||||
3. Use short internal cables to reduce easy probing
|
||||
4. Label power banks generically (avoid project names)
|
||||
|
||||
| USB & HDMI | Ethernet Ports |
|
||||
| --------------------------------------- | --------------------------------------- |
|
||||
| .jpeg>) | .jpeg>) |
|
||||
|
||||
#### Environmental & Operational Practices
|
||||
|
||||
Recommendations:
|
||||
|
||||
* Store boxes in controlled locations when not in use
|
||||
* Rotate devices periodically in long deployments
|
||||
* Assume devices may be copied or lost
|
||||
* Treat Butter Boxes as semi-disposable infrastructure, not personal devices.<br/>
|
||||
|
||||
### Section 2: Digital Tamper Resistance
|
||||
|
||||
#### Credential Hygiene (Critical)
|
||||
|
||||
Mandatory actions:
|
||||
|
||||
SSH
|
||||
|
||||
* By default, the pi user has the password butterbox-admin.
|
||||
* Change this password by sshing into the pi and running passwd.
|
||||
* If you'd prefer to use an SSH key, be sure to disable password access once you enable key-based access.
|
||||
|
||||
RaspAP
|
||||
|
||||
* The access point has an administrative interface that can be used to change its settings.
|
||||
* Defaults: user: admin, password: secret (ironically, this is not secret).
|
||||
* Change this by logging in at[ http://butterbox.lan/admin](http://butterbox.lan/admin) (or[ http://comolamantequilla.lan/admin](http://comolamantequilla.lan/admin) for a Spanish language box) and using the Web UI.
|
||||
|
||||
Chat
|
||||
|
||||
* The local chat was created by an administrative user called butterbox-admin. The password for this user is also butterbox-admin.
|
||||
* Change this password by logging into the Butter Box, going to the public chatroom, then visiting your user profile and updating the password. At your discretion, you may also wish to change the name from butterbox-admin so that other users will recognize you.
|
||||
|
||||
Best practices:
|
||||
|
||||
* Use unique passwords per deployment
|
||||
* Store credentials offline in secure documentation
|
||||
* Never reuse credentials across regions
|
||||
|
||||
#### Service Hardening
|
||||
|
||||
Recommendations:
|
||||
|
||||
* Disable services not strictly required:
|
||||
* SSH (or restrict to key-based auth)
|
||||
* Bluetooth
|
||||
* USB ports
|
||||
|
||||
#### Content Integrity & Authenticity
|
||||
|
||||
Recommendations:
|
||||
|
||||
* Keep firmware immutable during normal operation
|
||||
* Maintain a known-good baseline image
|
||||
* Re-flash devices periodically in long deployments
|
||||
|
||||
Operational control:
|
||||
|
||||
* Only trusted operators should install or update content
|
||||
* Document update sources and dates
|
||||
|
||||
|
||||
|
||||
### Section 3: Misuse & Abuse Mitigation
|
||||
|
||||
#### Local Chat & Content Abuse
|
||||
|
||||
Risks:
|
||||
|
||||
* Harassment or hate speech
|
||||
* Impersonation
|
||||
* Disinformation spread
|
||||
|
||||
Mitigations:
|
||||
|
||||
* Clear usage guidelines displayed locally
|
||||
* Community moderation roles (if appropriate)
|
||||
* Ability to reset or wipe chat data quickly
|
||||
* Limit who can upload or replace content
|
||||
* Keep a read-only mode for most users
|
||||
|
||||
|
||||
|
||||
### Section 4: Incident Response & Recovery
|
||||
|
||||
Prepare for compromise:
|
||||
|
||||
* Assume some devices will be tampered with
|
||||
* Maintain a simple wipe and re-flash procedure
|
||||
* Track deployments
|
||||
|
||||
<br/>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"label": "Services",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "services/index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# File Sharing
|
||||
|
||||
<figure><img src="/img/docs/media-type-explore.png" alt=""/><figcaption></figcaption></figure>
|
||||
|
||||
## Share Media, Files and Digital Books
|
||||
|
||||
You can use your Butter Box to share media, files, and digital books. To display additional content in your portal, connect a USB drive containing the information you want to share.
|
||||
|
||||
If you’d like more control over how your content is displayed, you can build a **static website** and share it through the Butter Box. Learn more in the [Content Packs](../content-packs/) section.
|
||||
|
||||
|
||||
|
||||
### Add files to your USB Drive
|
||||
|
||||
Place individual files directly in the **main directory** (root) of your USB drive. Or, create folders to organize your files (eg. "Books", "Music", "Reports)
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2025-08-16 at 9.50.15 PM.png" alt=""/><figcaption><p>USB directory when viewed in Finder on desktop</p></figcaption></figure>
|
||||
|
||||
**Things to Know**
|
||||
|
||||
* The **folder names you use** on your USB drive will be shown in the Butter Box portal.
|
||||
* Organizing content into folders makes it easier for others to browse and download.
|
||||
|
||||
### Connect to your Butter Box to view
|
||||
|
||||
Insert the USB drive into your Butter Box. After connecting your USB drive to the Raspberry Pi you will see the **Files** tile displayed when you open the Butter Box portal.
|
||||
|
||||
<div><figure><img src="/img/docs/Screenshot_20260414-122810 (1).png" alt=""/><figcaption></figcaption></figure> <figure><img src="/img/docs/Screenshot_20260414-122821 (1).png" alt=""/><figcaption></figcaption></figure></div>
|
||||
|
||||
|
||||
|
||||
**Troubleshooting**
|
||||
|
||||
If you don’t see the **Files** tile, try the following actions:
|
||||
|
||||
* Remove the USB drive from the Butter Box. Then re-insert the USB drive.
|
||||
* Turn on/off airplane mode. Reconnect Butter Box wifi.
|
||||
* Refresh the browser page.
|
||||
|
||||
If you are still having trouble you may need to [Reformat Your USB Drive](../faq/how-to-reformat-your-usb-drive).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Features
|
||||
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
---
|
||||
description: A place for anyone connected to the box to share
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Local Chat
|
||||
|
||||
There is one local chat on your Butter Box that is open to anyone who is able to join the box. If they can open the portal, they can open the chat and say or post anything they want. Depending on your use case, moderation capabilities may be important.
|
||||
|
||||
First, let's look at what you can and can't do with this local chat.
|
||||
|
||||
✅ **You Can**<br/>
|
||||
|
||||
* Host videos up to 5 GB PDFs, images, record, audio messages, share pre-recorded audio messages or music
|
||||
* Download the full chat or any individual piece of content or media that people have shared
|
||||
|
||||
❌ **You Cannot**<br/>
|
||||
|
||||
* Use the chat to talk with people who are not connected to the Butter Box
|
||||
* Get notifications when there are new posts or messages
|
||||
* See the messages unless you are connected to the Butter Box
|
||||
|
||||
|
||||
|
||||
## Moderation
|
||||
|
||||
A Butter Box offers moderation features for the local chat. In order to access these features, you need to login as the admin of the room.
|
||||
|
||||
### Become the Admin
|
||||
|
||||
### Logout as Guest
|
||||
|
||||
When you open the local chat, you are assigned a guest identity. First logout of the account that was created for you.
|
||||
|
||||
### Login as Admin
|
||||
|
||||
Login to the `butterbox-admin` account. Username and password are both `butterbox-admin`.
|
||||
|
||||
### Change Admin Password
|
||||
|
||||
Visit your user profile to change the password. At your discretion, you may also wish to change your display name so that other users will recognize you.
|
||||
|
||||
### Moderation Features
|
||||
|
||||
Once you are an admin, you have access to the following features:
|
||||
|
||||
* **Set a message timer**
|
||||
* **Delete messages**
|
||||
* **Promote members to moderator or admin**
|
||||
* **Kick members out.**
|
||||
* Keep in mind that someone can simply rejoin as a new guest if they reconnect to the box
|
||||
* **Delete the room.**
|
||||
* Warning: If you delete the room, you will no longer have a local chat on your Butter Box. To get one back, you will have to flash a new image of the Butter Box software to your SD card.
|
||||
|
||||
|
||||
|
||||
## Say Even More—Direct Messages and Private Rooms
|
||||
|
||||
In addition to the local chat, you can create any number of private rooms from the same interface.
|
||||
|
||||
### Things To Know
|
||||
|
||||
* Each room will have it's own QR code.
|
||||
* Private rooms are not discoverable from the Butter Box portal.
|
||||
* If you create a private room, you have to share the QR code physically to whomever you want to join **who is also connected to the box.**
|
||||
* Every private chat that you are part of, will be easy for **you** to find. They will all show up in your room list.
|
||||
|
||||
### Instructions
|
||||
|
||||
You can create a private room from two different places in the message board interface.
|
||||
|
||||
### Open from Avatar Modal
|
||||
|
||||
Tap on your avatar in the top bar. Select **new room.**
|
||||
|
||||
| <img src="/img/docs/image.png" alt="" data-size="original"/> | |
|
||||
| -------------------------------------------------------------------- | - |
|
||||
|
||||
|
||||
|
||||
### Open from Room List
|
||||
|
||||
Your room list is accessible from your profile page. Once here, select **new room.**
|
||||
|
||||
<figure><img src="/img/docs/Screenshot 2026-01-20 at 1.42.17 PM.png" alt=""/><figcaption></figcaption></figure>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
description: Using Delta Chat with a Butter Box
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Private Messenger
|
||||
|
||||
With the Private Messenger service, you can exchange secure messages with people you know. [Delta Chat](https://delta.chat/) is a messaging app that uses email protocols to exchange messages. When used through a Butter Box, people who create accounts on the same Butter Box can send messages to each other without the internet.
|
||||
|
||||
Think of the Butter Box like a local post office. Whenever you connect to the Box’s network, your Delta Chat app can send outgoing messages and sync to receive any new ones waiting for you.
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
# Update Butter
|
||||
|
||||
### Check out new releases from the Butter Box team
|
||||
|
||||
[https://www.dropbox.com/scl/fo/helpqh3q2oj7ti2ia038m/h?dl=0.&rlkey=cswt4w4zksiuj3eb1oca48yw0](https://www.dropbox.com/scl/fo/helpqh3q2oj7ti2ia038m/h?dl=0.&rlkey=cswt4w4zksiuj3eb1oca48yw0)
|
||||
|
||||
:::info
|
||||
Always choose the Latest Version of the file
|
||||
:::
|
||||
|
||||
### Early Access Development Releases
|
||||
|
||||
WARNING: These are early releases posted for development testing and MUST NOT be used in production deployments.
|
||||
|
||||
[Download Early Access Development Images](https://files.sr2.uk/d/52bd8561a10d4d83be7b/?p=%2F&mode=list)
|
||||
|
||||
### Update your Butter Box
|
||||
|
||||
Update your Butter Box using the same guide with the steps you take when you are setting a Butter Box up for the first time. You can find it here: [Raspberry Pi Install](build-a-box/raspberry-pi/install-butter)
|
||||
Loading…
Add table
Add a link
Reference in a new issue