![]() Supported filters are the same as for the /catalog/v2/entries endpoint. Returns the full or filtered list of ZIM files as an OPDS acquisition feed with partial entries. Returns the full list of ZIM file languages as an OPDS Navigation Feed. If no illustration of requested size is found a HTTP 404 error is returned. Returns the illustration of size NxN pixels for the library entry with Name - include in the results only the entry with the specified Q - include in the results only entries that contain the specified text Maxsize - include in the results only entries whose size (in bytes) Notag - filter out (exclude) entries with any of the specified tags The result will contain only those entries Multiple tagsĬan be provided as a semicolon separated list (e.g ![]() Tag - filter by tags associated with the library entries. Lang - filter by language (specified as a 3-letter language code).Ĭategory - filter by categories associated with the library entries. Theįiltering criteria must be specified via the following URL parameters: Pagination is applied to the filtered list. $ curl ' # Returns all entries starting from entry # 100Ī filtered subset of the library can be requested by providing one or moreįiltering criteria, whereupon only entries matching all of the criteria are $ curl ' # Returns 50 entries starting from entry # 100 (i.e. $ curl ' # Returns the next 10 entries (internally numbered 10 through 19) # Returns the first 10 entries (internally numbered 0 through 9) Removes the limit on the number of results in the output. Will contain at most n (default value: 10) results starting from entry # The output of /catalog/v2/entries?start=s&count=n Obtain the remaining entries the URL query parameters start and/orĬount must be used. Returns a full or filtered list of ZIM files as a paginated OPDS acquisitionīy default, no more than 10 first entries are returned from the library. Returns the full list of ZIM file categories as an OPDS Navigation Feed. catalog/v2/searchdescription.xml ¶ĭescribes the /catalog/v2/entries endpoint in OpenSearch description format. The OPDS Catalog Root links to the OPDS acquisition and navigation feedsĪccessible through the other endpoints of the OPDS API. Legacy OPDS API is preserved for backward The new OPDS API of kiwix-serve is based on the OPDS Catalog specification Welcome page can be overriden through the -customIndex/ -cĬommand line option of kiwix-serve. By default this is the library page, whereīooks are listed and can be looked up/filtered interactively. search (with /search/searchdescription.xml) HTTP API endpoints presented below are relative to that location, i.e. urlRootLocation/ -r options, respectively. Kiwix-serve serves content at/under whereĪDDR, PORT and ROOT are the values supplied to the Max number of (concurrent) connections per IP (default: infinite, Override the welcome page with a custom HTML file. Wikipedia_en_all_2020-08 and wikipedia_en_all. ForĮxample, ZIM file wikipedia_en_all_2020-08.zim will be accessible both as The expected format of the date in the filename is _YYYY-MM. z, -nodatealiases ¶Ĭreate URL aliases for each content by removing the date embedded in the file Maximum number of ZIM files in a fulltext multizim search (default: No limit). Number of threads to run in parallel (default: 4). Prevent the users from directly navigating to external resources via such n, -nosearchbar ¶ĭisable the searchbox in the ZIM viewer toolbar. m, -nolibrarybutton ¶ĭisable the library home button in the ZIM viewer toolbar. Kiwix-serve process (this works regardless of the presence of the Library reloading can be forced anytime by sending a SIGHUP signal to the Monitor the XML library file and reload it automatically when it changes. a PID, -attachToProcess =PID ¶Įxit when the process with id PID stops running. d, -daemon ¶ĭetach the HTTP server daemon from the main process. URL prefix on which the content should be made available (default: empty). TCP port on which to listen for HTTP requests (default: 80). By default the server listens on allĪvailable IP addresses. That the command line argument is rather a library XML file. Providing the -library option tells kiwix-serve ![]() Options ¶ -library ¶īy default, kiwix-serve expects a list of ZIM files as command lineĪrguments. ZIM_FILE_PATH: ZIM file path (multiple arguments are allowed). Multiple library files canīe provided as a semicolon ( ) separated list. To be used only with the -library option. ![]() LIBRARY_FILE_PATH: path of an XML library file listing ZIM files to serve. ![]()
0 Comments
Leave a Reply. |