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)

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

  • FreeBSD

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

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.5 (python>=3.6 is recommended) 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 and install 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 either pyzbar or qreader (both are included in the application). 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). It’s recommended to use pyzbar as it supports reading multiple QR codes contained in a single image.

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

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)

  • Feeds (following IPNS hashes)

  • Sharing hashmarks over pubsub

  • File manager with drag-and-drop support

  • 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.5.3 (it is strongly suggested to use python>=3.6)

  • go-ipfs > 0.4.7

  • qt5

  • PyQt5 with QtWebEngine support

  • 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.4.tar.gz (2.7 MB view hashes)

Uploaded Source

Built Distribution

galacteek-0.4.4-py3-none-any.whl (3.2 MB view hashes)

Uploaded Python 3

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