IDigBio Media Appliance: Difference between revisions

From iDigBio
Jump to navigation Jump to search
(36 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Appliance]][[Category:Image Ingestion]][[Category:CYWG]]
[[Category:Appliance]][[Category:Image ingestion]][[Category:CYWG]]
== Purpose ==
== Overview ==


Facilitate ingestion of media files (images) into iDigBio from your local file system in a reliable manner and meeting the minimum [https://www.idigbio.org/sites/default/files/Image%20File%20Format%20Recommendations%20and%20Standards.pdf iDigBio requirements for media]. For an overview of the appliance, look at the CYberinfrastructure Working Group (CYWG) meeting [[Media:CYWG-ImageApplianceFeb19-2.pdf | presentation slides]].
The iDigBio Media Appliance is a cross-platform local web app that is used to upload media files from a local computer environment into iDigBio storage where the media become available on the public Internet.
 
The iDigBio Media Appliance fills the gap when an institution is not capable of publishing and hosting media on the Internet themselves.
 
;Documentation for the iDigBio Media Appliance is located in the [https://github.com/iDigBio/idigbio-media-appliance/wiki media appliance project wiki on github.]
 
The following historical links and background documents may also be useful:
 
* [https://www.idigbio.org/wiki/images/5/58/Image_File_Format_Recommendations_and_Standards.pdf iDigBio recommendations for media (PDF)]
* CYberinfrastructure Working Group (CYWG) meeting [[Media:CYWG-ImageApplianceFeb19-2.pdf | presentation slides (PDF)]]
* [[CYWG iDigBio Image Ingestion Appliance Use Cases| CYWG iDigBio Image Ingestion Appliance Use Cases]] - elaborates on use cases for the image ingestion appliance; community input is welcome to help refine and expand the list of use cases.


[https://www.idigbio.org/wiki/index.php/CYWG_iDigBio_Image_Ingestion_Appliance_Use_Cases This document] elaborates on use cases for the image ingestion appliance; community input is welcome to help refine and expand the list of use cases.
== Download Links ==
== Download Links ==
Get the image ingestion appliance from:
Get the image ingestion appliance from iDigBio's [https://github.com/iDigBio/idigbio-media-appliance/releases/latest latest github release].
* [http://www.acis.ufl.edu/~yonggang/idigbio/0.4.6/idigbio_image_ingestion_tool.0.4.6.win32.zip For Windows]
* [http://www.acis.ufl.edu/~yonggang/idigbio/0.4.6/idigbio_image_ingestion_tool.0.4.6.osx.dmg For Mac]
* [http://www.acis.ufl.edu/~yonggang/idigbio/0.4.6/idigbio-ingestion-tool-csv.zip Source Code]


== What do I need to provide?  ==
== What do I need to provide?  ==
The appliance requires the following:  
The appliance requires the following:  
#An internet browser (Chrome, Firefox, Safari and IE9 are supported and tested)
#A computer that meets the System Requirements as listed in the [https://github.com/iDigBio/idigbio-media-appliance/wiki/Installing "Installing" documentation].
#An iDigBio account with corresponding UUID and assigned API key  
#An iDigBio account with corresponding UUID and assigned API key  
#A set of image files residing on your local disk that are compliant with the [http://www.idigbio.org/sites/default/files/Image%20File%20Format%20Recommendations%20and%20Standards.pdf iDigBio Policy on Acceptable Formats for iDigBio-hosted Images]  
#A set of media files residing on your local disk that are compliant with the [https://www.idigbio.org/wiki/images/5/58/Image_File_Format_Recommendations_and_Standards.pdf iDigBio Recommendations on Acceptable Formats for iDigBio-hosted Media (PDF)]  
#A Creative Commons license that you would like to apply to all the images. If you need guidance on the selection, look at [http://www.idigbio.org/sites/default/files/iDigBio%20Intellectual%20Property%20Policy%2020120417.pdf iDigBio Intellectual License Property Policy].
#A Creative Commons license that you would like to apply to all the images. If you need guidance on the selection, look at [https://www.idigbio.org/content/idigbio-intellectual-property-policy iDigBio Intellectual License Property Policy].
#A comma-separated file (CSV) containing at least the full path to the location of each image and the GUID you would like to assign to the media metadata.


== What are the fields in the input CSV?  ==
== What are the fields in the input CSV?  ==
If you already have metadata about the media that you wish to include when the appliance performs its upload, the following document may be useful:
* [[Input CSV Format]]
* [[Input CSV Format]]
== Getting Started ==
* [[Getting Started]]


== FAQ  ==
== FAQ  ==


=== How can I get the account UUID and API key pair? ===
=== How can I get the account UUID and API key pair? ===
*You can get a account UUID / API key pair by contacting Alex Thompson (godfoder@acis.ufl.edu).
*You can get a account UUID / API key pair by contacting the iDigBio Technical Team ([mailto:idigbio@acis.ufl.edu idigbio@acis.ufl.edu]).


=== I have trouble installing the appliance on a Mac machine and I get the error message "iDigBio Image Ingestion Tool" can't be opened because it is from an unidentified developer. ===
=== I have trouble installing the appliance on a Mac machine and I get the error message "iDigBio Image Ingestion Tool" can't be opened because it is from an unidentified developer. ===
*[[Mac unidentified developer troubleshooting]]
*[[Mac unidentified developer troubleshooting]]


=== Why ingestion tool is not work on my machine? ===
=== Why is the ingestion tool not working on my machine? ===
*Please send Email to yonggang@acis.ufl.edu. Indicate your operating system, browser and the symptom or error message you get.
*Please send email to [mailto:idigbio@acis.ufl.edu idigbio@acis.ufl.edu]. Indicate your operating system, browser and the symptom or error message you get.


Go back to Cyberinfrastructure Working Group ([[Cyberinfrastructure Working Group|CYWG]]) page
Go back to Cyberinfrastructure Working Group ([[Cyberinfrastructure Working Group|CYWG]]) page

Revision as of 09:03, 28 September 2017

Overview

The iDigBio Media Appliance is a cross-platform local web app that is used to upload media files from a local computer environment into iDigBio storage where the media become available on the public Internet.

The iDigBio Media Appliance fills the gap when an institution is not capable of publishing and hosting media on the Internet themselves.

Documentation for the iDigBio Media Appliance is located in the media appliance project wiki on github.

The following historical links and background documents may also be useful:

Download Links

Get the image ingestion appliance from iDigBio's latest github release.

What do I need to provide?

The appliance requires the following:

  1. A computer that meets the System Requirements as listed in the "Installing" documentation.
  2. An iDigBio account with corresponding UUID and assigned API key
  3. A set of media files residing on your local disk that are compliant with the iDigBio Recommendations on Acceptable Formats for iDigBio-hosted Media (PDF)
  4. A Creative Commons license that you would like to apply to all the images. If you need guidance on the selection, look at iDigBio Intellectual License Property Policy.

What are the fields in the input CSV?

If you already have metadata about the media that you wish to include when the appliance performs its upload, the following document may be useful:

FAQ

How can I get the account UUID and API key pair?

  • You can get a account UUID / API key pair by contacting the iDigBio Technical Team (idigbio@acis.ufl.edu).

I have trouble installing the appliance on a Mac machine and I get the error message "iDigBio Image Ingestion Tool" can't be opened because it is from an unidentified developer.

Why is the ingestion tool not working on my machine?

  • Please send email to idigbio@acis.ufl.edu. Indicate your operating system, browser and the symptom or error message you get.

Go back to Cyberinfrastructure Working Group (CYWG) page