Skip to content

Latest commit

 

History

History
258 lines (192 loc) · 9.54 KB

README.rst

File metadata and controls

258 lines (192 loc) · 9.54 KB
Raw

https://gitlab.com/galacteek/galacteek/-/raw/master/share/icons/galacteek.png

info:A multi-platform browser and semantic agent for the distributed web

galacteek is a multi-platform Qt5-based browser and semantic agent for the distributed web

Where

galacteek is developed on GitLab (official website here).

Join in on the Telegram channel or in the Matrix room

Sponsor with Ko-fi

Installation

Please go to the download section on the website

On Linux: Be sure to install all the gstreamer packages on your system to be able to use the mediaplayer. Problem with the AppImage ? Check the wiki or file an issue

On MacOS: After opening/mounting the DMG image, hold Control and click on the galacteek icon, and select Open and accept. You probably need to allow the system to install applications from anywhere in the security settings. Create an issue if you have problems running the DMG image.

On Windows: GIT is not packaged in the installer. Install it here. If you run into an issue with the installer, please create an issue here .

You'll need to have git installed to sync hashmarks repositories.

Docker

Docker images are available. They run the full GUI inside a virtual Xorg server (using Xvfb). A VNC server runs on TCP port 5900 of the container, just use a regular VNC client to access the interface. The password to access the VNC service is printed to the console when starting the container.

Pull the image and run it with:

docker pull registry.gitlab.com/galacteek/galacteek-installer:pimp-my-dweb-latest-x11vnc
docker run -p 5900:5900 -t registry.gitlab.com/galacteek/galacteek-installer:pimp-my-dweb-latest-x11vnc

If you want to persist the container's galacteek data on your system, use the following:

mkdir /usr/local/galacteek-docker
docker run -p 5900:5900 -v /usr/local/galacteek-docker:/home/galacteek -t registry.gitlab.com/galacteek/galacteek-installer:pimp-my-dweb-latest-x11vnc

Open your VNC client using the container's IP address (port 5900) using the password issued on the container's console.

You can view all the available docker images here in the container registry.

Sponsor this project

See the sponsor page for all the possible ways to donate to this project.

Sponsor with Ko-fi Sponsor with Liberapay Sponsor with Github Sponsors

Contact

From the galacteek main window, go to the Messenger workspace and select Compose. In the recipient field, type in galacteek, select the galacteek-support contact, write your message and hit Send.

Alternatively, from the galacteek main window, go to the Information menu on the top right and select About. Just click on the Author link (cipres) and it will automatically start the BitMessage composer with my BitMessage address.

Screenshots

Browsing the Wikipedia mirror over IPFS

Browsing the Wikipedia mirror over IPFS

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 and p2p streams, or some features won't be available (Check this page for more information).

(Features list

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.

If you've changed some settings and want to go back to the default configuration, use --config-defaults.

You can run the IPFS daemon in offline mode, using --offline

Time-rotated log files can be found in the $HOME/.local/share/galacteek/main/logs directory

Enable colorized log output with --log-color

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

Keyboard shortcuts

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

Development

For instructions on how to build the application, look at the BUILDING page.

Contributions

Contributions that can help:

  • Write DID services
  • UI translations (French, Spanish)
  • Manual translations (French, Spanish)

Platforms supported

  • Linux (x86_64) (main target)
  • Linux (aarch64). If you have a Raspberry PI (64-bit), check the Raspberry page.
  • Any BSD operating system (with manual build)
  • MacOS

Unofficially supported:

  • Windows: although an installer is provided, no special effort will be put in maintaining support for this platform. Not all features will work. By all means use Linux and you'll enjoy the full experience.

Because of the nature of the software's stack (asyncio/Quamash), support for any other platform is unlikely.

Requirements

  • python3 >= 3.7 (Works with python 3.7, 3.8, 3.9)
  • kubo >= 0.14.0 (the installers include kubo version 0.17.0)
  • PyQt5 >= 5.13.2
  • PyQtWebengine >= 5.13.2
  • gstreamer (on Linux) for media player support
  • git
  • asyncqt
  • aiohttp
  • aioipfs

License

galacteek is offered under the GNU GPL3 license

The logos and animations are licensed under the Creative Commons CC-BY-SA license.

The BT client code (galacteek.torrent module) is licensed under the MIT license, Copyright (c) 2016 Alexander Borzunov

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

Some icons from the "Oxygen" icons set are included.

This software incudes icons made by the following FlatIcon authors:

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