Diskernet/README.md

125 lines
7.8 KiB
Markdown
Raw Normal View History

# :floppy_disk: [DiskerNet](https://github.com/c9fe/22120) [![source lines of code](https://sloc.xyz/github/crisdosyago/Diskernet)](https://sloc.xyz) [![npm downloads (22120)](https://img.shields.io/npm/dt/archivist1?label=npm%20downloads%20%2822120%29)](https://npmjs.com/package/archivist1) [![npm downloads (diskernet, since Jan 2022)](https://img.shields.io/npm/dt/diskernet?label=npm%20downloads%20%28diskernet%2C%20since%20Jan%202022%29)](https://npmjs.com/package/diskernet) [![binary downloads](https://img.shields.io/github/downloads/c9fe/22120/total?label=OS%20binary%20downloads)](https://GitHub.com/crisdosyago/DiskerNet/releases) [![visitors+++](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fc9fe%2F22120&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=%28today%2Ftotal%29%20visitors%2B%2B%2B%20since%20Oct%2027%202020&edge_flat=false)](https://hits.seeyoufarm.com) ![version](https://img.shields.io/npm/v/diskernet) [![DiskerNet slogan](https://img.shields.io/badge/%F0%9F%92%BE%20DiskerNet-an%20internet%20on%20yer%20disc-hotpink)](#DiskerNet) [:star: :eyes:](https://github.com/dosyago/DiskerNet/stargazers)
2023-01-14 18:07:52 +00:00
<h1>DiskerNet</h1>
<p>Introducing DiskerNet - the tool that connects to your browser and makes it easy to save and organize the things you discover online.</p>
<p>With DiskerNet, you can choose between two modes:</p>
<ul>
<li>Archive everything you browse, automatically saving every page you visit</li>
<li>Archive only what you bookmark, allowing you to selectively save the most important content</li>
</ul>
<p>No matter which mode you choose, DiskerNet makes it easy to search, browse, and share your archived content. Plus, our tool is lightweight and doesn't require any special plugins or extensions.</p>
<h2>Key features</h2>
<ul>
<li>Connects to your browser and automatically archives your browsing activity</li>
<li>Two modes: archive everything or only bookmark-worthy content</li>
<li>Easy-to-use interface for searching, browsing, and sharing your archives</li>
<li>Lightweight and doesn't require any special plugins or extensions</li>
</ul>
<h2>Why choose DiskerNet?</h2>
<ul>
<li>Never lose track of your favorite online content again</li>
<li>Save time by quickly finding the information you need</li>
<li>Share your archives with others, or keep them private</li>
<li>Easy to use and doesn't require any extra tools or plugins</li>
</ul>
<p>To get started with DiskerNet, simply download the tool and connect it to your browser. You'll be amazed at how much easier it is to save and organize the things you discover online.</p>
## Latest updates
**We now support local SSL certificates! :lock: :tada:** If you create a directory `$HOME/local-sslcerts` (where $HOME is your user home directory) and place in there `fullchain.pem` and `privkey.pem` created via [`mkcert`](https://github.com/FiloSottile/mkcert) (*ensure you also run `mkcert -install` to add the MkCert CA to your trust store root*), **then** when you start DK we will detect this and run the server over TLS. This means you can connect to your DK dashboard at: https://localhost:22120 which is just **so much cooler** :sunglasses:
2023-01-14 18:07:52 +00:00
<h2>Licensing</h2>
<p>DiskerNet is licensed under the Polyform Strict License 1.0.0. You can purchase a license for different uses below:</p>
- For personal, research, noncommercial purposes: Buy a Perpetual Non-commercial Use License of the current Version re-upped Monthly to the Latest Version, [USD$1.99 per month, paid yearly](https://buy.stripe.com/7sIg0acC5amT7PW6pl). Or [purchase an Unlimited Time version for the equivalent of 5 years](https://buy.stripe.com/14k5lw31veD96LS29b).
- For part of your internal tooling in your org: Buy a Perpetual Internal Use License of the current Version re-upped Monthly to the Latest Version, [USD $12.99 per month, paid yearly](https://buy.stripe.com/9AQaFQ59D52z3zGdRS), or [purchase an Unlimited Time version for the equivalent of 5 years](https://buy.stripe.com/fZe3do1Xr1Qn9Y4011).
- For anywhere in your business: Buy a Perpetual Small-medium Business License of the current Version re-upped Monthly to the Latest Version, [USD $99 per month, paid yearly](https://buy.stripe.com/eVa8xIcC5gLhfio6po). Or [purchase an Unlimited Time version for the equivalent of 5 years](https://buy.stripe.com/00g5lwcC566D7PW00Z).
## Get it
[Download a release](https://github.com/crisdosyago/Diskernet/releases)
or ...
**Get it on [npm](https://www.npmjs.com/package/diskernet):**
```sh
$ npm i -g diskernet@latest
```
or...
**Build your own binaries:**
```sh
$ git clone https://github.com/crisdosyago/DiskerNet
$ cd DiskerNet
$ npm i
$ ./scripts/build_setup.sh
$ ./scripts/compile.sh
$ cd bin/
```
### Frequently Asked Questions
**What is the licensing for Diskernet?**
Diskernet is licensed under the Polyform Strict License 1.0.0. This license allows individuals to use the tool for free for personal, noncommercial purposes. It also allows businesses and organizations to purchase a license for use in their internal tooling or anywhere in their business.
**Why did you choose the Polyform license for Diskernet?**
We chose the Polyform license for Diskernet because it offers several benefits. It protects our rights as the creators of the tool, it allows individuals to use the tool for free for personal use, and it allows businesses to purchase a license for use in their operations. We believe that the Polyform license strikes a good balance between the interests of the open source community and the rights of the creators of Diskernet.
**Is the Polyform license open source?**
The Polyform license is not an open source license as defined by the Open Source Initiative (OSI). However, it allows individuals to use the tool for free for personal, noncommercial purposes, and it allows businesses to purchase a license for use in their operations.
**Can I modify or distribute Diskernet under the Polyform license?**
No, the Polyform license does not allow users to modify or distribute Diskernet without the permission of the creators. This is to protect our rights as the creators of the tool and to ensure that our work is not used or distributed without our permission.
**Can I use Diskernet for commercial purposes?**
Yes, you can use Diskernet for commercial purposes if you purchase a license from us. The license allows businesses and organizations to use Diskernet for their own purposes, including in their internal tooling or anywhere in their business.
**What is Diskernet?**
Diskernet is a tool for archiving and organizing online content. It connects to your browser and automatically saves the pages you visit, allowing you to easily search, browse, and share your archived content.
**What are the key features of Diskernet?**
The key features of Diskernet include:
- Connects to your browser and automatically archives your browsing activity
- Two modes: archive everything or only bookmark-worthy content
- Easy-to-use interface for searching, browsing, and sharing your archives
- Lightweight and doesn't require any special plugins or extensions
**Why should I use Diskernet?**
There are several reasons to use Diskernet:
- Never lose track of your favorite online content again
- Save time by quickly finding the information you need
- Share your archives with others, or keep them private
- Easy to use and doesn't require any extra tools or plugins
**How do I get started with Diskernet?**
Getting started with Diskernet is easy! Simply download the tool and connect it to your browser. You'll be amazed at how much easier it is to save and organize the things you discover online.
**Does Diskernet work with all browsers?**
No, right now Diskernet is compatible with Chrome and Chromium only (although theoretically compatible with Edge owing to the Remote Debugging Protocol).