storm/gaming-image-files
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename upload_server.md to managing_files.md added download server documentation.

Browse Source
This commit is contained in:
Storm Dragon
2025-08-27 00:46:45 -04:00
parent 0c9058e454
commit dda52cbc6c
1 changed files with 150 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
home/stormux/Documents/upload_server.md → home/stormux/Documents/managing_files.md
View File

@@ -1,13 +1,17 @@
# File Management
The Stormux Gaming Image includes both upload and download servers to help you transfer files between your gaming system and other devices on your network. Both servers use web browsers for easy file management.
# Upload Server
The upload server provides a simple way to transfer files from other devices to your Stormux Gaming Image through a web browser. This is especially useful for adding music, ROM files, and other content to your system.
The upload server allows you to transfer files from other devices to your Stormux Gaming Image.
## Starting the Upload Server
1. Navigate to the **System** menu in the main game launcher
2. Select **Upload Server**
2. Select **Upload Files**
3. The server will start and announce the IP address and port
4. Example: "Server running on 192.168.1.100 port 8000"
4. Example: "Upload server running on 192.168.1.100 port 5000"
5. **Press any key** while the server is running to hear the address and port again
The server will continue running until you press **Control+C** to stop it, or until you restart the system.
@@ -173,10 +177,152 @@ Both your Stormux Gaming Image and the device you're uploading from must be conn
- Mount USB drives manually from terminal if needed
- Good for large file transfers or offline situations
# Download Server
The download server allows you to retrieve files from your Stormux Gaming Image to other devices on your network.
## Starting the Download Server
1. Navigate to the **System** menu in the main game launcher
2. Select **Download Files**
3. The server will start and announce the IP address and port
4. Example: "Download server running on 192.168.1.100 port 8000"
5. **Press any key** while the server is running to hear the address and port again
6. **Press 'q'** to quit the server cleanly
The server serves files from your home directory (`/home/stormux`) and all its subdirectories.
## Using the Download Server
### From Another Device
1. Make sure both devices are on the same network
2. Open a web browser on your phone, tablet, or computer
3. Go to the address announced by the server
4. Example: `http://192.168.1.100:8000`
### Browsing Files
The download server provides a simple directory listing interface:
- **Navigate Directories**: Click on folder names to browse subdirectories
- **Download Files**: Click on file names to download them
- **Parent Directory**: Use "Parent Directory" links to go back up
- **File Information**: See file sizes and modification dates
### Accessible Directories
From the download server, you can access:
- **Music/**: Your music collection organized by artist/album
- **Roms/**: Game ROM files organized by console system
- **Downloads/**: General downloaded files and utilities
- **Documents/**: Text files, documentation, and guides
- **Desktop/**: Desktop files and shortcuts
- **.local/**: Local application data and configurations
- **And more**: Any directory, subdirectory, or file in your home folder
## File Downloads
### What Gets Announced
The download server will speak announcements for actual file downloads only:
- **Music Files**: MP3, OGG, FLAC, WAV files
- **ROM Files**: NES, SNES, disk images, etc.
- **Documents**: PDF, text files
- **Archives**: ZIP, TGZ, TAR files
- **Other Content**: Any files with recognizable extensions
### What Stays Quiet
To avoid being too chatty, the server won't announce:
- **Directory Browsing**: Simply navigating folders
- **Web Assets**: Favicon, CSS, JavaScript files
- **Multiple Requests**: Repeated access to the same files
## Common Use Cases
### Save Game Backup
- Browse to game-specific directories
- Download save files to backup on other devices
- Useful before system updates or changes
### Music Collection Access
- Browse your ~/Music directory
- Download specific songs or albums
- Share music with other devices on your network
### ROM File Sharing
- Access your game collection from other devices
- Download ROMs to play on other systems
- Backup rare or hard-to-find ROM files
### Configuration Backup
- Download configuration files from .config directories
- Backup custom game settings
- Save important system configurations
## Network Requirements
### Same Network Connection
Both your Stormux Gaming Image and the downloading device must be on the same network:
- **Local Network Only**: Server only accepts local network connections
- **WiFi or Ethernet**: Either connection type works
- **Router-Based**: Both devices connected through the same router
### No Internet Required
- The download server works entirely on your local network
- No internet connection needed for file transfers
- Files never leave your local network
## Security Considerations
### Access Control
- **Local Network Only**: Server rejects external internet requests
- **No Authentication**: Anyone on your local network can access files
- **Read-Only Access**: Files can only be downloaded, not modified
- **Temporary Access**: Server stops when you quit it
### Best Practices
- **Run When Needed**: Only start the server when actively downloading files
- **Trusted Networks**: Only use on home or trusted networks
- **Monitor Access**: Server announces file downloads so you know what's being accessed
- **Clean Shutdown**: Always use 'q' to quit cleanly
## Troubleshooting
### Can't Access Download Server
- **Check Network**: Ensure both devices are on same network
- **Verify Address**: Press any key while server is running to hear address again
- **Port Conflicts**: If port 8000 is busy, server will announce the error
- **Firewall**: Network firewall may block access
### Downloads Fail or Stop
- **Large Files**: Very large files may take time or timeout
- **Network Stability**: Ensure stable network connection
- **Browser Limits**: Some browsers limit download sizes
- **Storage Space**: Check available space on downloading device
### Server Won't Start
- **Port In Use**: Another service may be using port 8000
- **Network Problems**: Check that system has network connectivity
### Speech Issues
- **No Announcements**: Check that speech-dispatcher is running
- **Wrong Information**: Press any key to hear current server information
- **Too Many Announcements**: Server now only announces actual file downloads
## Alternative File Sharing Methods
### Magic Wormhole
- Available for secure file transfers
- Use from terminal for device-to-device transfer
- More secure for sensitive files
### USB Storage
- Copy files directly to USB drives
- Good for large transfers or offline situations
- Mount USB drives from terminal if needed
### Network File Sharing
- DLNA server available for media sharing
- Can serve files to other network devices
- One-way sharing from gaming image to other devices
The upload server is the easiest way to get files onto your Stormux Gaming Image, especially for music and game content. Keep it running only when needed, and enjoy the convenience of wireless file transfers.
The download server complements the upload server perfectly - upload files when you want to add content to your gaming system, and download files when you need to retrieve content from it. Both servers make file management easy and accessible from any device on your network.