Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add OAuth info, and fix up tool URLs etc.
  • Loading branch information
samwilson authored Nov 14, 2024
1 parent 1e037cc commit 053b03b
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ Internet Archive Upload Tool
![CI](https://github.com/wikisource/ia-upload/workflows/CI/badge.svg)

A small tool to import DjVu files from Internet Archive to Wikimedia Commons.
See it in operation at [ia-upload.toolforge.org](https://ia-upload.toolforge.org/)
(or the test site at [ia-upload-test.toolforge.org](https://ia-upload-test.toolforge.org/))
See it in operation at [ia-upload.wmcloud.org](https://ia-upload.wmcloud.org)
(or the test site at [ia-upload-test.wmcloud.org](https://ia-upload-test.wmcloud.org))
and read the documentation at [wikitech.wikimedia.org/wiki/Tool:IA_Upload](https://wikitech.wikimedia.org/wiki/Tool:IA_Upload).

Please report bugs on Phabricator under the [#IA Upload project](https://phabricator.wikimedia.org/tag/ia_upload).

## Prerequesites
The actual format conversions are done by the following external tools, called from within IA Upload:

Expand All @@ -29,7 +31,9 @@ The actual format conversions are done by the following external tools, called f

url.rewrite-if-not-file += ( "/(.*)" => "/index.php$0" )

4. Register an oAuth consumer on [Meta](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration)
4. Register an OAuth consumer on [Meta](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration)
with a callback to e.g. `http://localhost/ia-upload/public/oauth/callback` (i.e. ending in `oauth/callback`)
5. Edit `config.ini` to add your consumer key and secret
6. Make sure the `jobqueue` directory is writable by the web server
and rights to "Create, edit, and move pages" and "Upload new files".
6. Edit `config.ini` to add your consumer key and secret, and the OAuth consumer's ID number
(this is used to link to recent changes).
8. Make sure the `jobqueue` directory is writable by the web server.

0 comments on commit 053b03b

Please sign in to comment.