You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lionel Dricot 57c69df5b6 support query in the URL 1 day ago
.gitignore Initial commit 3 years ago
LICENSE Fill out LICENSE template! Closes #17. 2 years ago
README.md I wrote offmini instead of offpunk in the README 1 day ago
offpunk.py support query in the URL 1 day ago
setup.py Introducing Offpunk 3 weeks ago

README.md

OFFPUNK

A command-line, text-based and offline-first Gemini and Web browser by Ploum.

Focused on Gemini first but with text-mode support for HTTP/HTML (gopher is planned), the goal of Offpunk is to be able to synchronise your content once (a day, a week, a month) and then browse it while staying disconnected.

Offpunk is a fork of the original AV-98 by Solderpunk and was originally called AV-98-offline as an experimental branch.

How to use

Offpunk is a single python file. Installation is optional, you can simply download and run "./offpunk.py" or "python3 offpunk.py" in a terminal.

You use the go command to visit a URL, e.g. go gemini.circumlunar.space. (gemini:// is assumed is no protocol is specified).

Links in pages are assigned numerical indices. Just type an index to follow that link. If page is too long to fit on your screen, the content is displayed in the less pager (by default). Type q to quit and go back to Offpunk prompt. Type less or l to display it again in less.

Use add to add a capsule to your bookmarks and bookmarks or bm to show your bookmarks (which are stored in an editable file in you .config).

Use offline to only browse cached content and online to go back online. While offline, the reload command will force a re-fetch during the next synchronisation.

Use the help command to learn about additional commands. Some abreviations are available. See abbrevs.

When launched with the "--sync" option, offpunk will run non-interactively and fetch content from your bookmarks and ressources tentatively accessed while offline. New content found in your bookmarks will be automatically added to your tour (use tour ls to see your current tour, tour without argument to access the next item and tour X where X is a link number to add the content of a link to your tour).

With "--sync", one could specify a "--cache validity" in seconds. This option will not refresh content if a cache exists and is less than the specified amount of seconds old.

For example, running

offpunk --sync --cache-validity 43200

will refresh your bookmarks if those are at least 12h old. If cache-validity is not set or set to 0, any cache is considered good and only content never cached before will be fetched.

Offpunk can also be configured as a browser by other tool. If you want to use offpunk directly with a given URL, simply type:

offpunk URL

To have offpunk fetch the URL at next sync and close immediately, run:

offpunk --fetch-later URL

TODO

Known issues in the code:

  • FIXME0: Certificates error are not handled in --sync

  • FIXME1: consider root file is always index.gmi or index.html

  • TODO: Update blackbox to reflect cache hits.

More

See how I browse Web/Gemini offline => gemini://rawtext.club/~ploum/2021-12-17-offline-gemini.gmi

Announces about Offpunk will be made on Ploum’s Gemlog => gemini://rawtext.club/~ploum/

Dependencies

Offpunk has no "strict dependencies", i.e. it will run and work without anything else beyond the Python standard library. However, it will "opportunistically import" a few other libraries if they are available to offer an improved experience or some other features. Python libraries requests, bs4 and readabliity are required for http/html support.

To avoid using unstable or too recent libraries, the rule of thumb is that a library should be packaged in Debian/Ubuntu.

  • Python-xdg will place your data, config and cache in place recommended by the XDG specs (usually it’s .local/share/offpunk, .config/offpunk and .cache/offpunk). Without it, look for ~/.offpunk or ~/.config/offpunk while the cache will be in ~/.cache/offpunk/.
  • Python-requests is needed to handle http/https requests natively (apt-get install python3-requests). Without it, http links will be opened in an external browser
  • BeautifulSoup4 and Readability are both needed to render HTML. Without them, HTML will not be rendered or be sent to an external parser like Lynx. (apt-get install python3-bs4 python3-readability or pip3 install readability-lxml)
  • The ansiwrap library may result in neater display of text which makes use of ANSI escape codes to control colour (not in Debian?).
  • The cryptography library will provide a better and slightly more secure experience when using the default TOFU certificate validation mode and is highly recommended (apt-get install python3-cryptography).
  • Python magic is useful to determine the MIME type of cached object. If not present, the file extension will be used but some capsules provide wrong extension or no extension at all. (apt-get install python3-magic)
  • Xsel allows to go to the URL copied in the clipboard without having to paste it (both X and traditional clipboards are supported). Also needed to use the copy command. (apt-get install xsel)

Features

  • Offline mode to browse cached content without a connection. Requested elements are automatically fetched during the next synchronization and are added to your tour.
  • HTML pages are prettified to focus on content. Read without being disturbed.
  • Support "subscriptions" to a page. New content seen in bookmarked pages are automatically added to your next tour.
  • TOFU or CA server certificate validation
  • Extensive client certificate support if an openssl binary is available
  • Ability to specify external handler programs for different MIME types (use handler)
  • Gopher proxy support (e.g. for use with Agena)
  • Advanced navigation tools like tour and mark (as per VF-1). Unlike AV-98, tour is saved on disk accross sessions.
  • Bookmarks
  • IPv6 support
  • Supports any character encoding recognised by Python

RC files

You can use an RC file to automatically run any sequence of valid Offpunk commands upon start up. This can be used to make settings controlled with the set or handler commanders persistent. You can also put a go command in your RC file to visit a "homepage" automatically on startup, or to pre-prepare a tour of your favourite Gemini sites or offline to go offline by default.

The RC file should be called offpunkrc and goes in $XDG_CONFIG_DIR/offpunk (or .config/offpunk or .offpunk if xdg not available)

Cache design

The offline content is stored in ~/.cache/offpunk/ as plain .gmi/.html files. The structure of the Gemini-space is tentatively recreated. One key element of the design is to avoid any database. The cache can thus be modified by hand, content can be removed, used or added by software other than offpunk.

There’s no feature to automatically trim the cache. It is believed that gemini content being lightweight, one would have to seriously browse a lot before cache size is an issue. If cache becomes too big, simply rm -rf the folders of the capsules taking too much space.