k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-18 21:16:47 +00:00

Files

T

Maurice 58f6a49f32 docs(wiki): document road trip, document sync, the TREK Places API and Dawarich

The 4.3.0 features had no pages, or pages that described an earlier
state. Three new pages and a rewrite:

- Road-Trip: the addon from enabling it to the phone tab, stays and a
  stop's End as the time you leave, pinned times and the backward
  schedule, daily travel times, the three driving limits, search along
  the route, via points, other ways and what avoiding tolls needs,
  following a track, the warning layer, MCP tools and troubleshooting.
- Document-Sync: switching stores on, binding a trip, what each store
  asks for and binds, direction and delete rules, conflicts, the
  mass-delete guard, renames and restores, what needs a look, limits,
  private addresses, and the MCP tools.
- TREK-Places-API: what the index is, where TREK asks it, what leaves
  the instance, switching it off or pointing it at a copy of your own,
  and what happens when it is down.
- Dawarich: brought up to date with suggestions, the journal fold,
  recorded routes, Atlas proposals and the wish list.

Places and search, documents, the addon and admin overviews, MCP
tools, environment variables, internal network access, the sidebar and
home link the new pages, and the in-app help picks them up from the
sidebar.

2026-09-19 21:45:16 +02:00

5.0 KiB

Raw Blame History

Documents and Files

Attach and manage documents, tickets, and other files for your trip.

Where to find it

Open the Files tab inside the trip planner, or navigate directly to /trips/:id/files.

Admin: Files is an addon. Enable it in Admin-Addons.

Uploading

Drag and drop files onto the upload area, click it to open the file picker, or paste an image directly into the Files panel.

Maximum file size: 50 MB per file.
Blocked file types: renderable documents (.svg, .svgz, .html, .htm, .shtml, .shtm, .xml, .xhtml, .xht), scripts (.js, .jsx, .ts, .tsx, .mjs, .cjs, .php, .py, .rb, .pl) and executables (.exe, .bat, .sh, .cmd, .msi, .dll, .com, .vbs, .ps1, .app) — these are always rejected, as is any file whose MIME type contains svg.
Default allowed types: jpg, jpeg, png, gif, webp, heic, pdf, doc, docx, xls, xlsx, txt, csv, pkpass, pkpasses, md, markdown. An admin can customize the allowed list under Admin → Settings → Allowed File Types — comma-separated extensions, or * to allow everything except the blocked types above.

Requires the file_upload permission.

Browsing and filtering

The toolbar provides filter tabs, in this order: All, a star icon for Starred (only shown when at least one file is starred), PDFs, Images, Documents, and Collab Notes (only shown when files exist from collaborative notes). Each tab shows a count badge.

Previewing files

Clicking a file that is neither an image nor a video (e.g., PDF or Markdown) opens an inline preview modal with options to open in a new tab or download. .pkpass and .pkpasses Wallet passes are the exception: clicking one downloads it straight away, so the OS can hand it to Apple Wallet rather than forcing it into the in-app preview. Clicking an image or video file opens a full-screen lightbox. You can:

Navigate between images and videos using the arrow buttons or the left/right arrow keys.
Swipe left/right on touch devices.
Jump to a specific file using the thumbnail strip at the bottom. Videos have no stored thumbnail and show a play placeholder there.
Download or open the file in a new tab from the lightbox header.

Starring

Click the star icon on any file to favorite it. Starred files sort to the top of the list and can be filtered with the Starred tab.

Requires the file_edit permission.

Trash

Deleting a file moves it to the trash. Switch to the trash view using the Trash button in the toolbar. From the trash view you can:

Restore a file to make it active again.
Permanently delete a single file.
Empty trash to permanently remove all trashed files at once.

Restore and delete operations require the file_delete permission.

Linking files to places, reservations, or assignments

A file can be attached to multiple places and reservations at the same time (many-to-many). From the file manager, click the link (pencil) icon on a file to open the assign modal. From there you can toggle links to any trip place or reservation. You can also add a descriptive note to the file in the same modal.

From a reservation modal, use the "link existing file" picker to attach files directly.

Downloading

Click the download icon on any file row to download it. .pkpass files (Apple Wallet passes) are served with the application/vnd.apple.pkpass MIME type, so Safari on iOS and macOS offers to add the pass to Wallet instead of saving it as a generic download.

Document sync

A trip's documents can be kept in step with a self-hosted document store: Paperless-ngx, Papra, Nextcloud, OpenCloud or a Synology NAS. Once a store is available, a Document sync button sits next to Trash in the toolbar; on the phone it is at the top of the Files tab. The trip owner connects the store there once, and from then on what someone uploads here appears in the store, and what someone files in the store appears here.

Synced documents are ordinary files in this manager. Preview, starring, links, trash and download work as described on this page, and a document deleted here is only removed in the store when the binding is set to do so.

See Document-Sync for setup per store, the delete and conflict rules, and troubleshooting.

Admin: Each store is switched on separately under the Documents addon in Admin-Addons. They ship switched off.

Permissions

Permission	Controls
`file_upload`	Uploading new files.
`file_edit`	Starring and linking files.
`file_delete`	Moving to trash, restoring, and permanently deleting.

5.0 KiB Raw Blame History