summaryrefslogtreecommitdiff
path: root/help/IndexPackDownloader_p.md
blob: ef1819a2676ff8c014725a107bd93c70f36e5acc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
page: htroot/IndexPackDownloader_p.html
help: help/IndexPackDownloader_p.md
title: Index Pack Downloader
package: import-export-federation
access: admin
kind: admin-page
backend_java: source/net/yacy/htroot/IndexPackDownloader_p.java
---

# Index Pack Downloader

## Purpose

Index Pack Downloader retrieves packaged YaCy index data.

Use it when a prepared index package should be installed instead of crawling from scratch.

## What You Can Do Here

- Index Pack Downloader retrieves packaged YaCy index data.
- Define the source, target, format, collection, and expected size before starting.
- Monitor progress because large transfers continue beyond the initial request.

## Page Architecture

Import and export pages translate external data formats into YaCy documents or move YaCy index data into another store. Most long-running actions create background work that should be monitored afterward.

## Correct Use

Prepare source and target details before starting: file path or URL, format, collection, credentials if needed, and expected size. Imports and exports can continue in the background, so confirm progress on the related monitor or queue page.

## Access And Safety

Administrator access is required. YaCy protects `_p` pages as administration pages.

Protected related endpoint(s): `/IndexPackDownloader_p.html`.

## Automation And API

Page backend: `source/net/yacy/htroot/IndexPackDownloader_p.java`.

| Endpoint | Method | Access | Backend |
| --- | --- | --- | --- |
| `/IndexPackDownloader_p.html` | `GET or POST` | admin | `source/net/yacy/htroot/IndexPackDownloader_p.java` |

### Parameter Guide

The table explains values that an agent or script must set deliberately. Parameters not relevant to a task should be omitted or left at the page default.

| Parameter | Meaning and valid values | Care |
| --- | --- | --- |

Example request shape:

```http
GET or POST /IndexPackDownloader_p.html?dlfile=...&dlrepoid=...&dlsource=...
```

## What To Expect

Small operations may finish during the request; large imports, exports, harvests, and package operations usually need monitoring. Expect progress, logs, queue entries, or generated files rather than instant final search quality.

## Related Pages

- Related transfer work is usually reached through the import/export page for the same format, the index-pack pages, or the queue/status page that reports progress.