Django Files Android Client Documentation

website·Indexed 30 days ago

https://django-files.github.io

Documentation for the native Android application, covering installation, setup procedures using .sxcu files, available features, and event triggers such as File Uploaded and File Deleted.

Tokens: 2.4K
Snippets: 14
Records: 23
Agent score: 25%

What's inside Django Files

Install and setup the Django Files Android app
The native Android application can be installed via GitHub releases or Obtainium. To set up the server connection, navigate to User Settings > Clients on your Django Files site and click View QR Authentication Code. You can then either tap the QR code on your phone or scan it from a computer, then click Add Server in the app.
```
APK Signature Verification Hash:
A0:11:F5:75:CA:69:54:E4:0A:97:A0:C9:85:AC:35:FB:99:3F:DA:73:37:0B:97:EA:23:7D:02:F1:0A:41:2F:D0
```
https://django-files.github.io/llms.txtwebsitellms
Upload files to Django Files
Files can be uploaded via the website using drag-and-drop (dropping files into a specific album uploads them to that album). For external uploads, use your Auth Token and Site URL (available in the user menu) with a supported upload client. One-click configurations for clients are available under User Settings > Clients.
https://django-files.github.io/llms.txtwebsitellms
Setup Django Files for macOS and iOS via Shortcuts
For macOS and iOS, Django Files can be integrated using the Apple Shortcuts app. Note that this method is intended to be replaced by a dedicated iOS Client in the future.
https://django-files.github.io/llms.txtwebsitellms
Set up Live Streaming (RTMP)
Django Files includes a built-in RTMP server for live streaming via HLS. The server listens on port 1935 internally. You must expose this port on your host machine. Note that RTMP is not HTTP and will not pass through standard reverse proxies or CDNs; you must allow inbound TCP on the host port in your firewall/security groups.
```
# Docker Compose example
services:
  django-files:
    image: ghcr.io/django-files/django-files:latest
    ports:
      - '80:80'
      - '1935:1935' # host port : container port
    volumes:
      - media_dir:/data/media
```
https://django-files.github.io/llms.txtwebsitellms
Setup ShareX integration for Android
To integrate ShareX with Django Files on Android, download the .sxcu configuration file from the web interface and import it into ShareX.
1. Navigate to: User Settings > Clients
2. Click the ShareX Files or URL Shorts icon to download the .sxcu file.
3. If the file doesn't open automatically, go to: Destinations > Custom uploader settings > Import and select the file.
https://django-files.github.io/llms.txtwebsitellms
Install and setup the Django Files iOS app
The native iOS client is available on the Apple App Store. To add a server, go to User Settings > Clients on your Django Files site and click View QR Authentication Code. Tap the QR code on your iPhone (which opens the app automatically) or scan it with the camera, then tap Add Server.
https://django-files.github.io/llms.txtwebsitellms
Create site-wide webhooks for superusers
While regular webhooks only fire for a user's own activity, superusers can create site-wide webhooks. These are configured under Site Settings → Site Webhooks and receive events for every user on the instance, including account registrations and deletions.
https://django-files.github.io/llms.txtwebsitellms
Configure Webhook notifications
Django Files can send notifications to Discord or custom HTTP endpoints when specific events occur. Webhooks are managed under Settings → Webhooks.
- Discord: Supports rich embeds for image previews, video thumbnails, and stream announcements.
- Custom Endpoints: Receives a JSON payload. Payloads can be verified using an HMAC-SHA256 signature sent in the X-Webhook-Signature header.
https://django-files.github.io/llms.txtwebsitellms
Install and setup the Django Files Browser Addon
The web extension is available for major browsers via the Chrome Web Store and Mozilla Addons. To configure it, navigate to your Django Files site and activate the extension popup, then click Authorize Server. Alternatively, you can manually enter your URL and Token in the extension settings.
https://django-files.github.io/llms.txtwebsitellms
Configure Flameshot for Linux
To use Flameshot with Django Files, navigate to User Settings > Clients on the server and download the .sh script. Save this script securely on your system. The script uses curl to upload the captured file to the server, so curl must be installed on your system.
https://django-files.github.io/llms.txtwebsitellms
Install Django Files using Docker
The fastest way to deploy Django Files is using Docker. You must map port 80 for web traffic and port 1935 for RTMP if live streaming is required. Ensure the /data/media volume is mapped to persist files and database data.
```
# Using Docker CLI
docker run --name "django-files" -d --restart unless-stopped  \
  -p 80:80 -p 1935:1935 \
  -v /data/django-files:/data/media  \
  -e USERNAME=myadminuser  \
  -e PASSWORD=pleasechangeme  \
    ghcr.io/django-files/django-files:latest
```
https://django-files.github.io/llms.txtwebsitellms
Install and setup the Django Files CLI
A Command Line Interface is available for Python 3. After installation, run the setup command to interactively provide server details, which are stored in your home directory.
```
# Install via pip
python -m pip install zipline-cli

# Alternatively, install from source
git clone https://github.com/cssnr/zipline-cli.git
python3 -m pip install -e zipline-cli

# Configure the CLI
zipline-cli setup
```
https://django-files.github.io/llms.txtwebsitellms