Skip to main content

IPFS browser

Project description

https://gitlab.com/galacteek/galacteek/raw/master/share/icons/cube-nova-aqua.png
info:

A multi-platform IPFS browser

galacteek is an experimental multi-platform Qt5-based browser/toolbox for the IPFS peer-to-peer network.

Platforms supported

  • Linux (main target)

  • FreeBSD (or any BSD OS, as long as you have PyCryptodome)

  • MacOS (experimental, probably a lot of asyncio-related instability)

If it works for you, great, but most likely it won’t :) This started as an experiment with quamash and is WIP.

If you want to donate to this project please use the Patreon page

Installation

On Linux systems you can use the AppImage (from the releases page) or install from PyPI. On MacOS and other systems you’ll need to install from PyPI.

PyPI

You need to have python>=3.6 and pip installed. From a virtualenv, or as root, install with:

pip install galacteek

Upgrade with:

pip install -U galacteek

Or building it from source:

pip install -r requirements.txt
python setup.py build install

Now just run the application with:

galacteek

If you don’t have go-ipfs already installed, the application will ask you if you want to automatically download it from dist.ipfs.io You need a recent version of go-ipfs (> 0.4.7) with the new DAG API.

For the media player to work on Linux, you will need to install the gstreamer (1.x) package and all the gstreamer plugins.

There is experimental support for reading QR codes containing IPFS addresses, using pyzbar. pyzbar depends on the zbar shared library, so make sure it’s installed on your system (on Linux look for a libzbar or libzbar0 package and install it, on MacOS install it with brew install zbar).

AppImage

For Linux users (arch: x86_64), you can get an AppImage from the releases page. The script used to build the image can be found here

Command-line usage

Use the -d command-line switch to enable debugging output. Using –profile gives you the ability to have separate application profiles (main is the default profile). Use –help for all options.

Development: Use –monitor to enable event-loop monitoring with aiomonitor (install aiomonitor manually as it’s not a dependency). Then connect to the aiomonitor interface with nc localhost 50101

URL schemes

Right now the application relies on the dweb:/ URL scheme. We are using CIDv1 by default for all content. Starting with go-ipfs version 0.4.21, objects using CIDv1 are in base32 by default, creating the possibility to integrate other URL schemes (like ipfs://<cidv1-base32>) that will treat the CID as the authority. Work is being done to integrate such schemes in the browser and make it the default.

Features

galacteek can either spawn an IPFS daemon and use it as transport, or connect to an existing IPFS daemon. By default it will try to run a daemon. You can change the IPFS connection settings by clicking on the settings icon in the toolbar and restart the application afterwards. If using a custom daemon, you should enable pubsub or some features won’t be available.

  • Browsing sessions with automatic pinning (pins every page you browse)

  • File manager with drag-and-drop support

  • Following IPNS hashes

  • Sharing hashmarks over pubsub

  • Basic built-in media player with IPFS-stored playlists

  • Search content with the ipfs-search search engine

  • Image viewer

  • QR codes from images

  • Decentralized application development/testing with the Javascript API (using window.ipfs)

Keyboard shortcuts

Please see the shortcuts page (or from the application, click on the Information icon in the toolbar, which will open the documentation).

Screenshots

Browsing the Wikipedia mirror over IPFS

Browsing the Wikipedia mirror over IPFS

QR codes

IPFS QR codes

Contributions and contact

Contributions and ideas are more than welcome! Contact by mail at: galacteek AT protonmail DOT com

Requirements

  • python3 >= 3.6

  • go-ipfs >= 0.4.7

  • PyQt5 >= 5.12.2

  • PyQtWebengine >= 5.12

  • gstreamer (on Linux) for media player support

  • quamash

  • aiohttp

  • aioipfs

License

galacteek is offered under the GNU GPL3 license

Some elements from the ipfs-css repository (CSS files and fonts) are included.

Some icons from the “Oxygen” icons set are included.

Some of the beautiful artwork (under the Creative Commons CC-BY-SA license) from the ipfs-logo project’s repository is included, unchanged.

Main icon made by srip (flaticon, CC by 3.0)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

galacteek-0.4.5.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

galacteek-0.4.5-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

Details for the file galacteek-0.4.5.tar.gz.

File metadata

  • Download URL: galacteek-0.4.5.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.8

File hashes

Hashes for galacteek-0.4.5.tar.gz
Algorithm Hash digest
SHA256 3b57f519e1887b5644a20fd1b1b2bba766f4a5f7324844e61f84275fb91cf172
MD5 7226c49124325bdd13e4c2e4acdc208a
BLAKE2b-256 4f11d3298d342e05ae64d1933fa41b351826198175bad0d64f4d569531958dea

See more details on using hashes here.

Provenance

File details

Details for the file galacteek-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: galacteek-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.8

File hashes

Hashes for galacteek-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d74282d9ac03c6eecec70d4eea289a23b729871b41134eef9e71e8477a1d1391
MD5 b48a8ae9f79b7ec99142264e1188d28f
BLAKE2b-256 da02d87caed0b04ff5d72e547e3614d29550af7b7bbc67a4d598ab23a6016262

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page