funeralhomes-grab/README.md

34 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2022-05-18 01:36:37 +00:00
Setup instructions
=========================
Be sure to replace `YOURNICKHERE` with the nickname that you want to be shown as, on the tracker. You don't need to register it, just pick a nickname you like.
In most of the below cases, there will be a web interface running at http://localhost:8001/. If you don't know or care what this is, you can just ignore it—otherwise, it gives you a fancy view of what's going on.
**If anything goes wrong while running the commands below, please scroll down to the bottom of this page. There's troubleshooting information there.**
Build and install using Docker. There's a Makefile you can use, but change the username. It will also assume you want to put the data in /media/thetechrobo/2tb/obitdata. (This does not include data for failed items.) The Docker container will be removed when it finishes, so if the item failed, and you need the data, do not stop the contianer until you've gotten it.
2022-05-18 01:36:37 +00:00
_Can you tell I didn't intend to make this code public?_
2022-05-18 01:36:37 +00:00
## Tracker setup.
Yeah, there's no public tracker. That's on purpose.
2022-05-18 01:36:37 +00:00
Here's how to set one up.
2022-05-18 01:36:37 +00:00
1. Install universal-tracker: https://github.com/marked/universal-tracker/tree/docker-redisgem2
2. Add a new project named "funeralhomes".
3. Put item names like "type:item"; example: `tharpsontheimerfh:Rosco-Hornsby`. You can find a list of current types in pipeline.py.
4. Test it out, fix bugs, add stuff!
2022-05-18 01:36:37 +00:00
### Issues in the code
If you notice a bug and want to file a bug report, please use the GitHub issues tracker.
Are you a developer? Help write code for us! Look at our [developer documentation](http://archiveteam.org/index.php?title=Dev) for details.
### Other problems
Have an issue not listed here? Join us on IRC and ask! We can be found at hackint IRC [#//](https://webirc.hackint.org/#irc://irc.hackint.org/#//).