Skip to content
Bridging the elementary OS and Web user experiences
Vala JavaScript Python Meson CSS TSQL Other
Branch: master
Clone or download

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

Issues From Other Platforms

While Odysseus is primarily targetted towards elementary OS, I do welcome issues to be reported about breakages in other platforms. And I welcome Odysseus's app icon to be reworked for those themes as well, whether you want to contribute that work to my repository or their's.

Because I've had an easy dealing with past issues in this regard, and I have people interested in using Odysseus on those other platforms. I want them to have a great experience too.

NOTE: This notice is in no way a condemnation of app devs who are asking not to have to deal with these issues. It should only indicate that some app devs have an easier time dealing with them than others through no fault of their own.

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

Please see the guide, and join the Matrix room to discuss your ideas or get help.

You can’t perform that action at this time.