https://github.com/pfrazee/dat-gateway

Quick Dat to HTTP gateway
https://github.com/pfrazee/dat-gateway

Last synced: 12 days ago
JSON representation

Quick Dat to HTTP gateway

• Host: GitHub
• URL: https://github.com/pfrazee/dat-gateway
• Owner: pfrazee
• Created: 2017-05-27T03:32:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-12T19:08:50.000Z (almost 6 years ago)
• Last Synced: 2024-12-28T17:12:02.871Z (22 days ago)
• Language: JavaScript
• Size: 48.8 KB
• Stars: 47
• Watchers: 8
• Forks: 18
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - pfrazee/dat-gateway - Quick Dat to HTTP gateway (others)

README

        
# dat-gateway

[![Stability](https://img.shields.io/badge/stability-experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)

[![NPM Version](https://img.shields.io/npm/v/dat-gateway.svg)](https://www.npmjs.com/package/dat-gateway)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Build Status](https://travis-ci.org/garbados/dat-gateway.svg?branch=master)](https://travis-ci.org/garbados/dat-gateway)

**No longer maintained. Check out the https://github.com/garbados/dat-gateway fork instead.**

A configurable in-memory [Dat](https://datproject.org/)-to-HTTP gateway, so you can visit Dat archives from your browser.

If you want a browser that can visit Dat archives, check out [Beaker](https://beakerbrowser.com/).

## Install

To get the `dat-gateway` command for running your own gateway, use [npm](https://www.npmjs.com/):

```

npm i -g dat-gateway

```

## Usage

You can run `dat-gateway` to start a gateway server that listens on port 3000. You can also configure it! You can print usage information with `dat-gateway -h`:

```

$ dat-gateway -h

dat-gateway

Options:

  --version     Show version number                                    [boolean]

  --config      Path to JSON config file

  --port, -p    Port for the gateway to listen on.               [default: 3000]

  --dir, -d     Directory to use as a cache.[string] [default: "~/.dat-gateway"]

  --max, -m     Maximum number of archives to serve at a time.     [default: 20]

  --maxAge, -M  Number of milliseconds before archives are removed from the

                cache.                                         [default: 600000]

  -h, --help    Show help                                              [boolean]

```

You can visit Dat archives through the gateway using a route like this:

```

http://localhost:3000/{datKey}/{path...}

```

For example:

```

http://localhost:3000/40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9/assets/img/beaker-0.7.gif

```

The gateway will even resolve URLs using [Dat-DNS](https://github.com/beakerbrowser/beaker/wiki/Authenticated-Dat-URLs-and-HTTPS-to-Dat-Discovery):

```

http://localhost:3000/garbados.hashbase.io/icons/favicon.ico

```

## Contributions

All contributions are welcome: bug reports, feature requests, "why doesn't this work" questions, patches for fixes and features, etc. For all of the above, [file an issue](https://github.com/garbados/dat-gateway/issues) or [submit a pull request](https://github.com/garbados/dat-gateway/pulls).

## License

[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)