db290e40ff
- Fix missing brace. - Switch to more flexible report URL format. - Document `report` field. - Add 4tan to the archives.md table.
32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
Generic archive information:
|
|
|
|
```json
|
|
{
|
|
"uid": 1234,
|
|
"name": "Archive Name",
|
|
"domain": "example.com",
|
|
"http": true,
|
|
"https": true,
|
|
"software": "foolfuuka",
|
|
"boards": ["a"],
|
|
"files": ["a"],
|
|
"search": ["a"],
|
|
"report": "https://example.com/report/?board=%board&no=%post"
|
|
}
|
|
```
|
|
|
|
Most entries should be self-explanatory.
|
|
|
|
`uid` stands for "unique id", used on the client-side to save archive-specific settings.
|
|
The `uid` for a new archive should be an increment of the highest one,
|
|
make sure it does not overlap with an archive that previously died for example.
|
|
|
|
`software` can be `"foolfuuka"` or `"fuuka"` for example.
|
|
|
|
`files` is the list of boards whose files (images, videos, pdfs) are also archived, even temporarily, and not just thumbnails.
|
|
|
|
`search` is the list of boards where search is enabled. If this field is missing then it implies that search is enabled on all boards.
|
|
|
|
`report` is the URL of a form for reporting posts. The board name and post number will be substituted for `%board` and `%post`, respectively. If missing, it means your site has no such form.
|
|
|
|
Also, be sure to add your board to [archives.md](https://github.com/MayhemYDG/archives.json/blob/gh-pages/archives.md) at some point. |