monolith/README.md

119 lines
4.8 KiB
Markdown
Raw Normal View History

[![Monolith Build Status for GNU/Linux](https://github.com/Y2Z/monolith/workflows/GNU%2FLinux/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AGNU%2FLinux)
[![Monolith Build Status for macOS](https://github.com/Y2Z/monolith/workflows/macOS/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AmacOS)
[![Monolith Build Status for Windows](https://github.com/Y2Z/monolith/workflows/Windows/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AWindows)
2019-10-08 05:46:08 +02:00
```
2020-06-18 06:19:16 +02:00
_____ ______________ __________ ___________________ ___
| \ / \ | | | | | |
| \_/ __ \_| __ | | ___ ___ |__| |
| | | | | | | | | | | |
| |\ /| |__| _ |__| |____| | | | | __ |
| | \___/ | | \ | | | | | | |
|___| |__________| \_____________________| |___| |___| |___|
2019-10-08 05:46:08 +02:00
```
2019-08-24 19:51:37 +02:00
A data hoarders dream come true: bundle any web page into a single HTML file. You can finally replace that gazillion of open tabs with a gazillion of .html files stored somewhere on your precious little drive.
2017-02-20 08:51:24 +01:00
Unlike the conventional “Save page as”, `monolith` not only saves the target document, it embeds CSS, image, and JavaScript assets **all at once**, producing a single HTML5 document that is a joy to store and share.
2017-02-20 08:51:24 +01:00
2019-08-25 23:28:46 +02:00
If compared to saving websites with `wget -mpk`, this tool embeds all assets as data URLs and therefore lets browsers render the saved page exactly the way it was on the Internet, even when no network connection is available.
2017-02-20 08:51:24 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Installation
2017-02-20 08:51:24 +01:00
2021-03-10 02:52:23 +01:00
#### Using [Cargo](https://crates.io/crates/monolith)
$ cargo install monolith
2021-03-10 02:52:23 +01:00
#### Via [Homebrew](https://formulae.brew.sh/formula/monolith) (macOS and GNU/Linux)
2019-12-13 01:27:26 +01:00
$ brew install monolith
2021-03-10 02:52:23 +01:00
#### Using [Snapcraft](https://snapcraft.io/monolith) (GNU/Linux)
2020-01-14 09:42:04 +01:00
$ snap install monolith
2021-03-10 02:52:23 +01:00
#### Using [FreeBSD packages](https://svnweb.freebsd.org/ports/head/www/monolith/) (FreeBSD)
2021-03-10 00:31:15 +01:00
$ pkg install monolith
2021-03-10 02:52:23 +01:00
#### Using [FreeBSD ports](https://www.freshports.org/www/monolith/) (FreeBSD)
2020-06-17 13:42:10 +02:00
$ cd /usr/ports/www/monolith/
$ make install clean
#### Using [pkgsrc](https://pkgsrc.se/www/monolith) (NetBSD, OpenBSD, Haiku, etc)
$ cd /usr/pkgsrc/www/monolith
$ make install clean
2021-03-10 02:52:23 +01:00
#### Using [pre-built binaries](https://github.com/Y2Z/monolith/releases) (Windows, ARM-based devices, etc)
Every release contains pre-built binaries for Windows, GNU/Linux, as well as platforms with non-standart CPU architecture.
2020-07-13 07:16:38 +02:00
2021-03-10 02:52:23 +01:00
#### Using [containers](https://www.docker.com/)
2021-03-10 00:31:15 +01:00
$ docker build -t Y2Z/monolith .
$ sudo install -b utils/run-in-container.sh /usr/local/bin/monolith
2020-04-05 01:05:49 +02:00
#### From source
2019-12-26 01:00:58 +01:00
2020-04-28 15:07:47 +02:00
Dependency: `libssl-dev`
2019-12-26 01:00:58 +01:00
2020-04-05 01:05:49 +02:00
$ git clone https://github.com/Y2Z/monolith.git
$ cd monolith
$ make install
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Usage
2020-01-21 02:48:34 +01:00
$ monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html
2020-12-26 09:59:24 +01:00
or
2021-03-10 03:04:32 +01:00
$ cat index.html | monolith -aIiFfcMv -b https://original.site/ - > result.html
2017-02-20 08:51:24 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Options
- `-a`: Exclude audio sources
2021-02-16 02:38:06 +01:00
- `-b`: Use custom `base URL`
- `-c`: Exclude CSS
- `-e`: Ignore network errors
- `-f`: Omit frames
- `-F`: Exclude web fonts
2019-08-23 11:15:21 +02:00
- `-i`: Remove images
2020-02-15 07:33:20 +01:00
- `-I`: Isolate the document
2019-08-23 12:09:32 +02:00
- `-j`: Exclude JavaScript
- `-k`: Accept invalid X.509 (TLS) certificates
2020-12-10 03:23:17 +01:00
- `-M`: Don't add timestamp and URL information
2021-06-02 15:41:41 +02:00
- `-n`: Extract contents of NOSCRIPT elements
2021-02-16 02:38:06 +01:00
- `-o`: Write output to `file`
2020-06-25 23:38:39 +02:00
- `-s`: Be quiet
2021-02-16 02:38:06 +01:00
- `-t`: Adjust `network request timeout`
2021-06-02 15:41:41 +02:00
- `-u`: Provide custom `User-Agent`
- `-v`: Exclude videos
2017-02-20 08:51:24 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2020-12-13 19:42:41 +01:00
## Proxies
Please set `https_proxy`, `http_proxy`, and `no_proxy` environment variables.
2020-01-21 05:02:45 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2020-01-21 02:48:34 +01:00
## Contributing
Please open an issue if something is wrong, that helps make this project better.
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Related projects
2021-06-02 15:41:41 +02:00
- Monolith Chrome Extension: https://github.com/rhysd/monolith-of-web
- Pagesaver: https://github.com/distributed-mind/pagesaver
- Personal WayBack Machine: https://github.com/popey/pwbm
- Hako: https://github.com/dmpop/hako
- Monk: https://gitlab.com/fisherdarling/monk
2019-10-07 13:57:02 +02:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## License
2021-03-01 06:54:46 +01:00
To the extent possible under law, the author(s) have dedicated all copyright related and neighboring rights to this software to the public domain worldwide.
This software is distributed without any warranty.
2019-08-23 05:17:15 +02:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-08-23 05:17:15 +02:00
<!-- Microtext -->
<sub>Keep in mind that `monolith` is not aware of your browsers session</sub>