Skip to content
Bridging the elementary OS and Web user experiences
Branch: master
Clone or download
Latest commit 83afa94 May 20, 2019

README.md

Odysseus web browser

Build Status

A simple and performant yet powerful elementary OS-style window onto the open decentralized web.

Odysseus is already and will continue to be a convenient, privacy-respecting, ethically designed, and opensource (under the GPLv3+ license) web browser that should run great on any free desktop. However work is ongoing to make Odysseus more convenient with handy navigation aids that gently and unobtrusively guide you wherever you want to go online.

In doing so Odysseus aims to help you focus on the webpages that matter to you, and to support the open decentralized web over the centralized services of today.

Get it on AppCenter or download a stable release

Technical Architecture

In a nutshell Odysseus pulls together WebKitGTK and SQLite using GTK/Granite, splitting off minor enhancements to it's core UI into builtin "traits".

At the same time Odysseus pulls together the same SQLite database, web-APIs, and more into a templating language. Which is then used to develop helpful error pages and handy navigation aids accessible via a custom odysseus: URI scheme.

Building

First ensure Git, W3C's HTML XML Utils (optional), Meson, Ninja, and the Vala compiler are installed, along with:

  • GTK+ 3
  • Granite
  • WebKit2 GTK
  • JSON GLib
  • LibSoup 2.4
  • SQLite 3
  • LibAppStream
  • LibGCR 3
  • Gettext

developer packages.

On elementary OS these dependencies can be installed with:

sudo apt install meson valac libgtk-3-dev libsqlite3-dev libwebkit2gtk-4.0-dev libgranite-dev
sudo apt install libjson-glib-dev libsoup2.4-dev libappstream-dev libgcr-3-dev gettext html-xml-utils

If your on other Debian-based distributions these commands should still work, except you may find the libgranite-dev package is unavailable. You may need to follow their installation instructions.

Then within the repository's root run the fullowing commands (or some OS-specific variation):

mkdir build
cd build
meson ..
ninja
sudo ninja install

Contributing

For anyone interested in contributing new features, fixes, etc to Odysseus, pull requests are always welcome and there is a discussion Matrix room for you to discuss your ideas or get help. If you don't know where to start, try one of these feature requests.

If you want to help teach Oddysseus a new language, please visit https://github.com/alcinnz/Odysseus/wiki/Localizing-Odysseus. Work is ongoing to make this easier.

You can’t perform that action at this time.