Skip to content

Commit

Permalink
Moves locations guide
Browse files Browse the repository at this point in the history
- Removes supported locations table
  - Somewhat redundant and now we have a nice table of contents!
- Removes `hyper://` note
  - Documentation should not include un-implemented features
  • Loading branch information
Shrinks99 committed Dec 23, 2023
1 parent a23a0d5 commit 48d3964
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 77 deletions.
27 changes: 27 additions & 0 deletions docs/docs/develop/locations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Supported Location URLs

ReplayWeb.Page uses URLs to uniquely identify web archives.

In addition HTTP/S, the system supports loading from additional cloud providers and via peer-to-peer decentralized services. The goal is to support loading web archives from any source a web browser can connect to.

The following is a list of currently supported URL schemes and details below:

## HTTP and HTTPS

While `https://replayweb.page` can load archived items from any URL, the hosting server must allow access by [enabling cross origin resource sharing](/develop/cors-settings). HTTP URLs may not be accessible from `https://replayweb.page` since it requires HTTPS.

## Local Files

Local files selected via the UI file chooser, and will be given a `file://` URL. Unlike other web archive URLs, file URLs can not be shared with others.

## Amazon S3

The `s3://` URL scheme is provided as a convenience to reference S3 URLs. The URL is converted to an HTTPS URL for access. The S3 Bucket must be public and also provide access to `https://replayweb.page` via CORS. Downloading via S3 credentials is not currently supported.

## Google Drive

The `googledrive://` URL scheme is used when accessing a web archive shared over Google Drive. It provides a unique identifier provided via Google Drive. When accessing a Google Drive URL, users will be asked to authenticate to be able to access the file.

## IPFS

The `ipfs://` URL scheme is provided as a convenience and resolves to Cloudflare's IPFS Gateway to download archives from IPFS.
77 changes: 0 additions & 77 deletions docs/locations.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ nav:
- Develop:
- develop/embedding.md
- develop/cors-settings.md
- develop/locations.md
# - User Guide:

markdown_extensions:
Expand Down

0 comments on commit 48d3964

Please sign in to comment.