DOCSEARCHbyAlgolia
Submit Docs

Zipline Android Documentation

website·Indexed 32 days ago

https://zipline-android.cssnr.com

Documentation for Zipline Android, covering the Files page, server-side file loading, list display settings, bulk options, file preview functionality, and application settings.

Tokens
1.8K
Snippets
1
Records
19
Agent score
50%

What's inside Zipline

  1. Manage users and server settings

    The application provides management tools for users and administrators:

    • User Management: Edit username, password, copy tokens, enable/disable TOTP, and change avatars using the built-in cropper.
    • Administrator Tools: Generate thumbnails, clear temporary files, clear zero-byte files, and requery file sizes.

  2. Install Zipline Android application

    Zipline is a Native Kotlin Android Application requiring Android 8+ (API 26+). It can be installed via GitHub releases, Obtainium (recommended), or the Google Play Store (currently in Closed Testing). Users installing the APK directly may need to enable installation from unknown sources.

  3. Upload files, text, and URLs

    The upload interface provides different options based on the content type:

    • Single File: Provides a preview and allows setting the File Name.
    • Multiple Files: Provides a grid preview (images only) and a file selector.
    • Text: Allows editing the text before upload. Defaults to paste.txt if no filename is provided.
    • Short URL: Allows editing the URL and the vanity name.

    Per-Upload Options: For all uploads, users can configure the Folder, Password, Max Views, Expiration (Deletes At), and Image Compression.

  4. Use the application debug log

    Enabling debugging logs actions like login attempts and background updates to a text file. The log is displayed in reverse chronological order (newest lines at the top) within the application and can be cleared from the settings menu.

  5. Upload files, text, or URLs to Zipline

    Zipline supports uploading via both 'Share' and 'Open With' intents from other Android applications.

    For Files: Select one or multiple files in another app, choose Share or Open, and select Zipline. You can preview files and set options (Folder, Password, Max Views, Deletes At, File Name Format, Custom File Name, and Image Compression Percent) before uploading.

    For Text or URLs: Select text or a link, choose Share, and select Zipline. You can edit the content or set a Vanity Name for links before uploading.

    After a successful upload, the resulting URL is automatically copied to the clipboard.

  6. Log in to a Zipline Server

    To log in, provide the Zipline Server URL (copy the URL from a browser and use everything before the /dashboard segment), Username, and Password. If Two-Factor Authentication (2FA) is enabled on the server, a code will be requested after the initial login. The app supports Zipline server version 4.

  7. Manage files on the Files page

    The Files page displays recent files from the server with pagination and caching. Users can view file details including original name, human-readable size, view count, favorite status, and password status.

    Available actions:

    • Single File Menu: Download, Delete, Favorite, Share Link, Copy Link, and Open Link.
    • Bulk Actions: Download, Delete, and Favorite.
    • Preview: Clicking a file opens a preview. Supported types include Video/Audio (via Media3), Images/Animated Graphics (via Glide), and Text with syntax highlighting (via HighlightJS).

  8. Zipline Server and Client Version Compatibility

    To ensure proper functionality, the Zipline Android client must meet minimum version requirements based on the server version:

    • Authentication: Zipline Server v4.4.1 requires Client v1.0.32 or greater.
    • File Uploads: Zipline Server v4.3.0 requires Client v1.0.29 or greater.

  9. Manage user profiles and administrative tasks

    The User page provides profile and account management:

    • User Management: Copy Auth Token, change username/password, enable/disable TOTP, and manage avatars (crop, remove, share, or refresh).
    • Session Management: Log out or refresh profile/stats/avatar.
    • Administrative Tasks: Admins can trigger 'Generate Thumbnails', 'Clear Temp Files', and 'Clear Zero-Byte Files'.

  10. Configure general application settings

    The Settings page allows customization of the app's behavior:

    • Start Destination: Choose whether the app launches to the Home page or the Files page.
    • Show Share after Upload: If enabled, automatically shows the system share sheet after a file is uploaded or a URL is shortened.
    • Custom Headers: Add custom HTTP headers to every request (including the Home WebView), useful for services like Cloudflare Zero Trust.

  11. Configure background updates and the Stats Widget

    The application uses Android Work Manager for background updates, with a minimum interval of 15 minutes.

    Update Interval Settings:

    • Set to Disabled to stop all background tasks.
    • Toggle updates for: User Stats (required for Widget), User Profile, and User Avatar.

    Widget Customization:

    • Visuals: Text Color, Background Color, and Background Opacity.
    • Functions: The widget provides an Upload button, Refresh button, and a shortcut to launch the application.
    • Stats: Displays total number of files, total size, and the last client-side update time.

  12. Configure file list and media loading

    Adjust how files are loaded and displayed in the list:

    • Auto Play Media: Automatically plays media files when selected from the list.
    • Files Per Page: Determines the number of files loaded initially and during scroll. If set lower than the screen height, the app will continue fetching until the viewport is filled.
    • Load Images on Metered Connection: When enabled, prevents non-cached images from loading on metered connections (a warning is displayed). Note: Opening a file preview always downloads the media regardless of this setting.