README

wallabag

 [!IMPORTANT]
 The name of this project is wallabag — all lowercase, always. Not "Wallabag", not "WallaBag", not any other variation. Just plain, humble, all-lowercase wallabag 😉





!License

wallabag is a web application allowing you to save web pages for later reading.
Click, save and read it when you want. It extracts content so that you won't be distracted by pop-ups and cie.

You can install it on your own server, or you can create an account on wallabag.it.

!wallabag

 Website: wallabag.org
 Android app: wallabag/android-app
 iOS app: wallabag/ios-app
 Browser extension: wallabag/wallabagger
 GNOME (Linux) app: read-it-later (not maintained by this project)
 All resources about wallabag ecosystem are listed here: https://github.com/wallabag/wallabag/wiki/wallabag-ecosystem

 Documentation

The documentation is available at https://doc.wallabag.org.

The source files live in the doc/ directory of this repository.

 Installation

Please read the documentation to see the wallabag requirements.

Then you can install wallabag by executing the following commands:

bash
git clone https://github.com/wallabag/wallabag.git
cd wallabag && make install


If your system's default make is not GNU make, use gmake install instead.

Now, configure a virtual host to use your wallabag.

 Other methods

Refer to the installation documentation for other installation methods.

 Translation

This project uses Weblate for translation.

Feel free to help us translating wallabag.

 Contributing

To learn more about developing wallabag, please refer to the contribution guide.

Content extraction relies on Graby, php-readability and ftr-site-config.

 Sponsors



 License
Copyright © 2013-current Nicolas Lœuillet 

This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the COPYING.md file for more details.