[PR #159] [CLOSED] Add API server to provide remote link additions #1075

New issue

Closed

opened 2026-03-01 14:48:19 +03:00 by kerem · 0 comments

kerem commented

2026-03-01 14:48:19 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ArchiveBox/ArchiveBox/pull/159
Author: @MatthewJohn
Created: 3/4/2019
Status: ❌ Closed

Base: master ← Head: master

📝 Commits (5)

16ca3db Fix bug, as fixed by raman325 in https://github.com/pirate/ArchiveBox/pull/156
802b786 Start to API server
41d4acb Complete API to add services
68f4ab8 Fixes to docker file and exception handling
902793b Revert accidental changes to main Dockerfile

📊 Changes

4 files changed (+235 additions, -0 deletions)

View changed files

➕ Dockerfile.api (+67 -0)
➕ archivebox/api_server.py (+40 -0)
➕ archivebox/archive_queue.py (+114 -0)
📝 docker-compose.yml (+14 -0)

📄 Description

Summary

This PR add the ability to do run an API server instead of a single run of the archiver, allowing user to post new URLs to index: e.g.:

http://localhost:8099/add-link?url=https://github.com/

This then gets added to a queue and a thread picks up the new URLs and processes them

Changes these areas

Config
Bugfixes
Command line interface
Feature behavior
Internal design
Archived data layout on disk

Roadmap Goals

This PR helps us move towards 'add an optional web GUI for managing sources, adding new links, and viewing the archive' roadmap goal, as outlined here: https://github.com/pirate/ArchiveBox#roadmap

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ArchiveBox/ArchiveBox/pull/159 **Author:** [@MatthewJohn](https://github.com/MatthewJohn) **Created:** 3/4/2019 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (5) - [`16ca3db`](https://github.com/ArchiveBox/ArchiveBox/commit/16ca3db2f31c96b71362de9d2457ebdcd3506015) Fix bug, as fixed by raman325 in https://github.com/pirate/ArchiveBox/pull/156 - [`802b786`](https://github.com/ArchiveBox/ArchiveBox/commit/802b7869fe07ba690075211903f4c45f79bec6f8) Start to API server - [`41d4acb`](https://github.com/ArchiveBox/ArchiveBox/commit/41d4acb59ee1dfb0fd2035c1a10e5a77fe54974e) Complete API to add services - [`68f4ab8`](https://github.com/ArchiveBox/ArchiveBox/commit/68f4ab8edfe42197cb6b4f2a2fac86789585887c) Fixes to docker file and exception handling - [`902793b`](https://github.com/ArchiveBox/ArchiveBox/commit/902793b438a480000bd149055f5ea8d649eb2f2b) Revert accidental changes to main Dockerfile ### 📊 Changes **4 files changed** (+235 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `Dockerfile.api` (+67 -0) ➕ `archivebox/api_server.py` (+40 -0) ➕ `archivebox/archive_queue.py` (+114 -0) 📝 `docker-compose.yml` (+14 -0) </details> ### 📄 Description # Summary This PR add the ability to do run an API server instead of a single run of the archiver, allowing user to post new URLs to index: e.g.: http://localhost:8099/add-link?url=https://github.com/ This then gets added to a queue and a thread picks up the new URLs and processes them # Changes these areas - [ ] Config - [ ] Bugfixes - [ ] Command line interface - [X] Feature behavior - [X] Internal design - [ ] Archived data layout on disk # Roadmap Goals This PR helps us move towards 'add an optional web GUI for managing sources, adding new links, and viewing the archive' roadmap goal, as outlined here: https://github.com/pirate/ArchiveBox#roadmap --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>