Skip to main content

IPFS browser

Project description

https://gitlab.com/galacteek/galacteek/raw/master/share/icons/galacteek.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

  • MacOS

  • FreeBSD

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.0.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

galacteek-0.4.0-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: galacteek-0.4.0.tar.gz
  • Upload date:
  • Size: 2.4 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.0.tar.gz
Algorithm Hash digest
SHA256 7a36b835aa58a163384b4c27d577f1c882acb1c3d50f91279a2299dcdd3497a2
MD5 a158c77d628fc287b618dfa5088ffb7a
BLAKE2b-256 a1551e49f1e5190fea8cddb83966a5aae970ac899a5152f707a7a3a34d8aee47

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: galacteek-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 2.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f9c034e8b9ad3ed749bcb2771a591c690f794ab5bab40f320014b94d8d9e4edb
MD5 a502109a1ccb259cea8736c4671983d1
BLAKE2b-256 818c5294cfa50252df5bf6c00ba65b944f57c4371161aebb0522840d7357be20

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