Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beakerbrowser/dathttpd
Replaced by Homebase! See https://github.com/beakerbrowser/homebase.
https://github.com/beakerbrowser/dathttpd
dat http p2p server
Last synced: 3 days ago
JSON representation
Replaced by Homebase! See https://github.com/beakerbrowser/homebase.
- Host: GitHub
- URL: https://github.com/beakerbrowser/dathttpd
- Owner: beakerbrowser
- License: mit
- Archived: true
- Created: 2017-01-27T18:40:48.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-17T21:48:14.000Z (over 6 years ago)
- Last Synced: 2024-10-02T13:35:05.062Z (about 1 month ago)
- Topics: dat, http, p2p, server
- Language: JavaScript
- Homepage:
- Size: 265 KB
- Stars: 280
- Watchers: 28
- Forks: 35
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dat - dathttpd - A Web server for Dat and HTTPS, with zero-config TLS. (Using Dat / Hosting & Dat Management)
- awesome-starred - beakerbrowser/dathttpd - Replaced by Homebase! See https://github.com/beakerbrowser/homebase. (http)
README
# dathttpd
---
DatHTTPD has been replaced by [Homebase](https://github.com/beakerbrowser/homebase)! Same basic design, but more features and an easier-to-pronounce name.
---
A Web server for [Dat](https://datprotocol.com) and HTTPS.
Dat sites are hosted at public keys, which are the equivalent of IP addresses in the P2P network. The pubkeys are ugly, though! Wouldn't it be nice if your dats could have nice DNS shortnames, and also rehost over HTTPS for people still on legacy browsers?
dathttpd is for you!
- Serve sites over Dat at `dat://{subdomain}.{yourdomain.com}`.
- Rehost those sites over `https://{subdomain}.{yourdomain.com}`.
- Get TLS certs automatically with Let's Encrypt.
- (Optionally) Auto-redirect from https -> dat.
- [Metrics dashboard](#metrics-dashboard)
## Getting started
### Start hosting your website with Dat
You can use the [Dat CLI](https://www.npmjs.com/package/dat) or the [Beaker
Browser](https://github.com/beakerbrowser/beaker).
After uploading your site to a Dat archive, identify the archive's URL. You'll
need this for your dathttpd config.
### Update your DNS records
Create an A record that points to your server's IP address.
### Firewall rules
Make sure your server is accessible by port 80 (http), 443 (https), and 3282 (dat).
## Usage
On your server, create a config file at `~/.dathttpd.yml` that follows this structure:
```yaml
letsencrypt:
email: '[email protected]'
agreeTos: true
sites:
my-site.com:
url: dat://1f968afe867f06b0d344c11efc23591c7f8c5fb3b4ac938d6000f330f6ee2a03/
my-other-site.com:
url: dat://ff34725120b2f3c5bd5028e4f61d14a45a22af48a7b12126d5d588becde88a93/
```
Then run
```
# install build dependencies
sudo apt-get install libtool m4 automake libcap2-bin build-essential
# install dathttpd (https://docs.npmjs.com/getting-started/fixing-npm-permissions)
npm install -g dathttpd
# give node perms to use ports 80 and 443
sudo setcap cap_net_bind_service=+ep `readlink -f \`which node\``
# start dathttpd
dathttpd
```
To daemonify the server in Debian-based systems, stop the dathttpd process and
then run:
```
# install a helper tool
npm install -g add-to-systemd
# create a systemd entry for dathttpd
sudo add-to-systemd dathttpd --user $(whoami) $(which dathttpd)
# start the dathttpd service
sudo systemctl start dathttpd
```
## Config
Here's an example `~/.dathttpd.yml`:
```yaml
ports:
http: 80
https: 443
metric: 8089
directory: ~/.dathttpd
letsencrypt:
email: '[email protected]'
agreeTos: true
sites:
my-site.com:
url: dat://1f968afe867f06b0d344c11efc23591c7f8c5fb3b4ac938d6000f330f6ee2a03/
datOnly: false
my-other-site.com:
url: dat://ff34725120b2f3c5bd5028e4f61d14a45a22af48a7b12126d5d588becde88a93/
datOnly: true
my-proxy.com:
proxy: http://localhost:8080
my-old-site.com:
redirect: https://my-site.com
```
### ports.http
The port to serve the HTTP sites. Defaults to 80. (Optional)
HTTP automatically redirects to HTTPS.
### ports.https
The port to serve the HTTPS sites. Defaults to 443. (Optional)
### ports.metric
The port to serve the prometheus metrics. Defaults to 8089. (Optional)
### directory
The directory where dathttpd will store your Dat archive's files. Defaults to ~/.dathttpd. (Optional)
### letsencrypt
Settings for LetsEncrypt. If false or unset, HTTPS will be disabled.
### letsencrypt.email
The email to send Lets Encrypt? notices to. (Required)
### letsencrypt.agreeTos
Do you agree to the terms of service of Lets Encrypt? (Required, must be true)
### sites
A listing of the sites to host. Each site is labeled (keyed) by the hostname you want the site to serve at.
Sites can either host dat archives or proxy to a URL. To make a dat-site, set the `url` attribute. To make a proxy, set the `proxy` attribute.
You'll need to configure the DNS entry for the hostname to point to the server. For instance, if using `site.myhostname.com`, you'll need a DNS entry pointing `site.myhostname.com` to the server.
### sites.{hostname}.url
The Dat URL of the site to host.
### sites.{hostname}.proxy
The HTTP URL of the site to proxy.
### sites.{hostname}.redirect
The HTTP URL of the site to redirect traffic to.
### sites.{hostname}.datOnly
If true, rather than serve the assets over HTTPS, dathttpd will serve a redirect to the dat:// location. Defaults to false. (Optional)
### sites.{hostname}.hsts
If true, serve the [HSTS header](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security). You can specify how long the strict-transport rule lasts as the value. (parsed using [the ms module](https://www.npmjs.com/package/ms)). If `true` is given, will default to 7 days. Defaults to false. (Optional)
## Command Line Flags
- `--config ` use the config file at the given path instead of the default `~/.dathttpd.yml`. Overrides the value of the `DATHTTPD_CONFIG` env var.
## Env Vars
- `DATHTTPD_CONFIG=cfg_file_path` specify an alternative path to the config than `~/.dathttpd.yml`
- `NODE_ENV=debug|staging|production` set to `debug` or `staging` to use the lets-encrypt testing servers.
## Metrics Dashboard
DatHTTPD has built-in support for [Prometheus](https://prometheus.io), which can be visualized by [Grafana](http://grafana.org/).
DatHTTPD exposes its metrics at port 8089. Prometheus periodically scrapes the metrics, and stores them in a database. Grafana provides a nice dashboard. It's a little daunting at first, but setup should be relatively painless.
Follow these steps:
1. [Install Prometheus](https://prometheus.io/download/) on your server.
2. [Install Grafana](http://grafana.org/download/) on your server.
3. Update the `prometheus.yml` config.
4. Start prometheus and grafana.
5. Login to grafana.
6. Add prometheus as a data source to grafana. (It should be running at localhost:9090.)
7. Import [this grafana dashboard](./grafana-dashboard.json).
Your prometheus.yml config should include have the scrape_configs set like this:
```yml
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['localhost:9090']
- job_name: 'dathttpd'
static_configs:
- targets: ['localhost:8089']
```
Report any issues you have along the way!