From 68129b4ed752102a8c9244651a9d76c8d40db100 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 12 Mar 2019 19:51:23 -0400 Subject: [PATCH] Updated Usage (markdown) --- Usage.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/Usage.md b/Usage.md index 901ffb1..50b9d46 100644 --- a/Usage.md +++ b/Usage.md @@ -89,7 +89,7 @@ Passing a URL as an argument here does not archive the specified URL, it downloa --- -### UI Usage +## UI Usage To access your archive, open `output/index.html` in a browser. You should see something [like this](https://archive.sweeting.me). @@ -97,5 +97,34 @@ You can sort by column, search using the box in the upper right, and see the tot Click the Favicon under the "Files" column to go to the details page for each link. +### Output Structure + +The `output/` folder containing the UI HTML and archived data has the structure outlined here. + +```yaml + - output/ + - index.json # Main index of all archived URLs + - index.html + + - archive/ + - 155243135/ # Archived links are stored in folders by timestamp + - index.json # Index/details page for individual archived link + - index.html + + # Archive method outputs: + - warc/ + - output.pdf + - screenshot.png + ... + + - sources/ + - getpocket.com-1552432264.txt + - stdin-1552291774.txt + ... + + - static/ # Staticfiles for the archive UI + - robots.txt +``` + \ No newline at end of file