https://github.com/httpreserve/httpreserve

Digital Preservation of HTTP in documentary heritage.
https://github.com/httpreserve/httpreserve

archives code4lib digipres digital-repositories digitalpreservation documentary-heritage internetarchive wayback waybackmachine webarchiving

Last synced: 2 months ago
JSON representation

Digital Preservation of HTTP in documentary heritage.

• Host: GitHub
• URL: https://github.com/httpreserve/httpreserve
• Owner: httpreserve
• License: gpl-3.0
• Created: 2017-03-12T19:41:52.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-05-26T18:07:50.000Z (almost 3 years ago)
• Last Synced: 2024-06-20T16:36:36.970Z (almost 2 years ago)
• Topics: archives, code4lib, digipres, digital-repositories, digitalpreservation, documentary-heritage, internetarchive, wayback, waybackmachine, webarchiving
• Language: Go
• Homepage:
• Size: 1.28 MB
• Stars: 21
• Watchers: 4
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          










# httpreserve

[![GoDoc](https://godoc.org/github.com/httpreserve/httpreserve?status.svg)](https://godoc.org/github.com/httpreserve/httpreserve)

[![Go Report Card](https://goreportcard.com/badge/github.com/httpreserve/httpreserve)](https://goreportcard.com/report/github.com/httpreserve/httpreserve)

A tool to check the status of a weblink and also see whether it is archived

in the [Internet Archive](https://archive.org/).

Try it out here [httpreserve.info](http://httpreserve.info)

## Default Server

The library comes with a default server mode that can be configured for

POST and GET requests. POST by default. Default port is :2040 but this can

also be selected at runtime.

![Image of the in-built HTTPPreserve server](src/images/defaultserver.png)

The default server can also be stood up as a web service. The API is

documented below.

## Client

The httpreserve linstat client is a separate application offering simple access

to httpreserve functionality through the command line. See [linkstat][ls-1]

[ls-1]: https://github.com/httpreserve/linkstat

The client application is a work in progress. Stay tuned for more

information about its capabilities.

## API

Primary entry point when the server is running:

*http://{httpreserve-ip-address}:{port}/httpreserve*

or

*http://{httpreserve-ip-address}:{port}/save*

**GET** example:

* Return JSON struct with information about the service you requested:

    [http://{httpreserve-ip-address}:{port}/httpreserve?url=http://www.google.com&filename=filename.txt][example-1]

[example-1]: http://httpreserve.info/httpreserve?url=http://www.google.com&filename=filename.txt

* Manage a save request to the internet archive and return HTTPreserve struct:

    [http://{httpreserve-ip-address}:{port}/save?url=http://www.google.com&filename=filename.txt][example-2]

[example-2]: http://httpreserve.info/httpreserve?url=http://www.google.com&filename=filename.txt

**POST** example:

    Same access point, but encode url and filename in a application/x-www-form-urlencoded form.

**OPTIONS** example:

    `curl -X OPTIONS http://httpreserve.info | less`

**RETURN** value:

'application/json' struct to work with, e.g.

```json

        {

        "AnalysisVersionNumber": "0.0.15",

        "AnalysisVersionText": "exponentialDK-httpreserve/0.0.15",

        "SimpleRequestVersion": "httpreserve-simplerequest/0.0.4",

        "Link": "http://example.com/",

        "Title": "example domain",

        "ContentType": "text/html; charset=UTF-8",

        "ResponseCode": 206,

        "ResponseText": "Partial Content",

        "SourceURL": "http://example.com/",

        "ScreenShot": "snapshots are not currently enabled",

        "InternetArchiveLinkEarliest": "http://web.archive.org/web/20020120142510/http://example.com/",

        "InternetArchiveEarliestDate": "2002-01-20 14:25:10 +0000 UTC",

        "InternetArchiveLinkLatest": "http://web.archive.org/web/20230526145524/https://example.com/",

        "InternetArchiveLatestDate": "2023-05-26 14:55:24 +0000 UTC",

        "InternetArchiveSaveLink": "http://web.archive.org/save/http://example.com/",

        "InternetArchiveResponseCode": 302,

        "InternetArchiveResponseText": "Found",

        "RobustLinkEarliest": "HTTPreserve Robust Link - simply replace this text!!",

        "RobustLinkLatest": "HTTPreserve Robust Link - simply replace this text!!",

        "PWID": "urn:pwid:archive.org:2023-05-26T14:55:24Z:page:http://example.com/",

        "Archived": true,

        "Error": false,

        "ErrorMessage": "",

        "StatsCreationTime": "883.557598ms"

        }

```

## Archiving Weblinks

* [Find and Connect Project:][laurent-1] Nicola Laurent on the impact of broken links.

* [Binary Trees? Automatically Identifying the links between born digital records:][spencer-1] I write about hyperlinks as a public record in own right when submitted as part of a documentary heritage.

## Robust links and Persistent Web Identifiers

HTTPreserve tries to promote the use of emerging standards such as Mementoweb's

Robust Links and the Royal Danish Library's Persistent Web-Identifiers (PWIDs).

More information about those can be found at the links below:

* [Robust Links][robust-1]

* [PWIDs][pwid-1]

## License

GNU General Public License Version 3. [Full Text](LICENSE)

[laurent-1]: http://www.findandconnectwrblog.info/2016/11/broken-links-broken-trust/

[spencer-1]: https://www.youtube.com/watch?v=Ked9GRmKlRw

[robust-1]: https://robustlinks.mementoweb.org/spec/

[pwid-1]: https://www.iana.org/assignments/urn-formal/pwid