2022-03-12 18:33:42 +00:00
# wallabag
2020-06-17 04:02:12 +00:00
2020-11-23 21:39:32 +00:00
![CI ](https://github.com/wallabag/wallabag/workflows/CI/badge.svg )
2024-10-31 07:17:40 +00:00
[![Matrix ](https://matrix.to/img/matrix-badge.svg )](https://matrix.to/#/#wallabag:matrix.org)
2020-06-16 17:13:58 +00:00
[![Donation Status ](https://img.shields.io/liberapay/goal/wallabag.svg?logo=liberapay )](https://liberapay.com/wallabag/donate)
2020-06-17 04:02:12 +00:00
[![Translation status ](https://hosted.weblate.org/widgets/wallabag/-/svg-badge.svg )](https://hosted.weblate.org/engage/wallabag/?utm_source=widget)
2022-03-12 18:33:42 +00:00
![License ](https://img.shields.io/github/license/wallabag/wallabag )
2015-04-02 09:45:53 +00:00
2022-03-12 18:33:42 +00:00
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.
2013-08-12 16:17:13 +00:00
2022-03-12 18:33:42 +00:00
You can install it on your own server, or you can create an account on [wallabag.it ](https://wallabag.it ).
2016-10-08 13:10:56 +00:00
2022-03-12 18:33:42 +00:00
![wallabag ](./.github/images/screenshot.png )
* Website: [wallabag.org ](https://wallabag.org )
* Android app: [wallabag/android-app ](https://github.com/wallabag/android-app )
* iOS app: [wallabag/ios-app ](https://github.com/wallabag/ios-app )
* Browser extension: [wallabag/wallabagger ](https://github.com/wallabag/wallabagger )
2023-01-01 20:16:33 +00:00
* GNOME (Linux) app: [read-it-later ](https://gitlab.gnome.org/World/read-it-later ) (not maintained by this project)
2023-07-06 13:31:50 +00:00
* All resources about wallabag ecosystem are listed here: https://github.com/wallabag/wallabag/wiki/wallabag-ecosystem
2022-03-12 18:33:42 +00:00
## Documentation
The documentation is available at https://doc.wallabag.org.
You can contribute to it through its dedicated repository, available here: https://github.com/wallabag/doc.
## Installation
2017-02-18 14:04:57 +00:00
2018-11-05 09:17:50 +00:00
Please read [the documentation to see the wallabag requirements ](https://doc.wallabag.org/en/admin/installation/requirements.html ).
2016-01-13 23:41:08 +00:00
2016-03-08 10:40:37 +00:00
Then you can install wallabag by executing the following commands:
2015-02-02 06:48:13 +00:00
2020-06-17 04:02:12 +00:00
```bash
2016-10-10 07:11:26 +00:00
git clone https://github.com/wallabag/wallabag.git
2018-10-24 19:02:35 +00:00
cd wallabag & & make install
2015-02-02 06:48:13 +00:00
```
2018-10-24 19:02:35 +00:00
Now, [configure a virtual host ](https://doc.wallabag.org/en/admin/installation/virtualhosts.html ) to use your wallabag.
2017-12-12 19:52:05 +00:00
2022-03-12 18:33:42 +00:00
### Other methods
2018-06-21 21:13:43 +00:00
2022-03-12 18:33:42 +00:00
Refer to the [installation documentation ](https://doc.wallabag.org/en/admin/installation/installation.html ) for other installation methods.
2018-06-21 21:13:43 +00:00
2022-03-12 18:33:42 +00:00
## Translation
2020-06-17 04:02:12 +00:00
2022-03-12 18:33:42 +00:00
This project uses [Weblate ](https://weblate.org/ ) for translation.
2020-06-17 04:02:12 +00:00
2022-03-12 18:33:42 +00:00
Feel free to help us [translating wallabag ](https://hosted.weblate.org/projects/wallabag/ ).
## Contributing
To learn more about developing wallabag, please refer to the [contribution guide ](./.github/CONTRIBUTING.md ).
Content extraction relies on [Graby ](https://github.com/j0k3r/graby ), [php-readability ](https://github.com/j0k3r/php-readability ) and [ftr-site-config ](https://github.com/fivefilters/ftr-site-config ).
## License
2018-10-24 19:02:35 +00:00
Copyright © 2013-current Nicolas Lœuillet < nicolas @ loeuillet . org >
2022-03-12 18:33:42 +00:00
2013-04-03 13:14:01 +00:00
This work is free. You can redistribute it and/or modify it under the
2022-03-12 18:33:42 +00:00
terms of the MIT License. See the [COPYING.md ](./COPYING.md ) file for more details.