mirror of
https://github.com/pirate/ArchiveBox.git
synced 2025-08-29 17:19:53 +02:00
Updated Usage (markdown)
31
Usage.md
31
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
|
||||
```
|
||||
|
||||
<img src="https://i.imgur.com/52RjhUM.png" width="45%">
|
||||
<img src="https://i.imgur.com/Gg9sTyq.png" width="45%">
|
Reference in New Issue
Block a user