How can I use CINCH?

If you are a library, archives, or other cultural heritage institution in North Carolina, you can use the hosted version of CINCH without installing it locally. Please contact us and we'll set you up with an account.

If you are not one of these institutions or would prefer to host CINCH yourself, please see our GitHub site for instructions on installing CINCH.

How do I create an upload list?

Simply create a file with a .txt or .csv extension, placing the full url for each file to download on its own line like so:

  • http://mysite.gov/pdfs/important.pdf
  • https://agency.org/files/2012/my_file.docx
  • http://anothersite.gov/docs/another_file.doc

You may want to use a website crawler or sitemap generator to facilitate this process.

Why can my upload list only have 500 files listed for CINCH to collect?

Our server has problems dealing with a large number files at one pass. However feel free to upload as many lists as you like. We'll get to them all.

Should I save a copy of my upload list(s)?

Yes, if you want to compare your upload list(s) with the file manifest contained in each zip file. Note: the files from any particular list might be split up over multiple zip files.

Why don't all the files on my list(s) appear in the same zip file?

There are several reasons this might happen:

  • A limit has been set on how large zip files can be and still be downloaded by our system. This necessiates splitting your files across multiple zip files if their total size is greater than 0.5GB.
  • We have a limit on how many total files CINCH can process at a given time, which means your files might need to be split up.

Why are my files deleted after 30 days?

Simply put, we don't have enough room on our server to keep everyone's files in perpetuity. You will receive an email 20 days after your files are processed notifying you that your files will be deleted soon.

What is the life cycle of my files in CINCH?

Here's a high level overview of what happens after you upload your url list:

  1. Each url from your list is written to a database for processing.
  2. Each file is downloaded.
  3. Each file is run through a virus check.
  4. Each file's checksum is generated.
  5. Each file's metadata is extracted.
  6. Each file's metadata is added to a metadata.csv file for inclusion in a zip file.
  7. Any files with errors have their error information added to an error.csv for inclusion in a zip file.
  8. Each file is added to a zip file along with the metadata.csv file, errors.csv file, and a file_events_history.csv file.
  9. You receive a message that you have files are ready for download.
  10. After 20 days you receive an email that your files will be deleted soon.
  11. After 30 days your files are deleted from the system.

For more information, you may want to review the documentation or the overview video.