- 1. Introduction
- 2. Package details
- 3. Installation prerequisites
- 4. Installation steps
- 5. Usage & validate installation
- 6. Privacy and data usage
- 7. Version history
The Elvis social import integration imports media files from social networks. It currently supports importing images from Twitter and is best combined with the Elvis AI integration. With AI, images are automatically tagged allowing you to better find relevant images.
This readme describes how to setup the integration. Please checkout this webinar if you want to know more about how to use cases and usage.
The integration consist of several components. The main component is the social import server app. This nodejs based server app handles all communication between Elvis and Twitter. The integration uses the Twitter streaming API, which allows us to register keywords (hashtags) we want to get Twitter images for. This is a live feed, so whenever a someone tweets an image, our integration is informed by Twitter and we can start importing the image into Elvis.
The second component is an Elvis web client plug-in. The Twitter panel plugin allows to manage topics. Each topic has one or multiple keywords to search for and links to a folder in Elvis where the images are stored.
- Fully installed and licensed Elvis Server.
- Minimum required version is Elvis 6.7.
- Machine where the social import server can run. This can be on the same machine where the Elvis Server runs or a different machine. Currently supported operating systems are Linux and OSX.
- Elvis API user license.
- A Twitter account.
This readme describes the high level installation steps. Detailed configuration information is embedded in the various configuration files.
The integration uses both standard and custom Elvis metadata fields to store information that came along with the tweet. The custom metadata fields need to be configured in the <Elvis Config>/custom-assetinfo.xml file. Sample configuration files are provided in the elvis-config folder.
The server can either be installed on the Elvis Server or on a separate machine.
- Clone or download this package.
- Open
src/config.tsand configure the settings. You can either configure the settings in this config file or by setting environment variables. - Install nodejs (8.9.3 or higher).
- Open a terminal and go to the package folder.
- Install TypeScript via npm:
npm install -g typescript. - Install node modules:
npm install. - Start the server:
npm start. - The server is correctly started when a startup message is showed.
This section describes how to install the Twitter plug-ins.
- Open the
elvis-pluginsfolder. - Copy the
social_apifolder to:<Elvis Config>/plugins/active. - Copy the
twitterfolder to:<Elvis Config>/plugins/active. - Activate the plugins.
The Twitter panel should now be available in the Elvis web client.
- Open the Elvis web client.
- Activate the Twitter panel on the right-hand side.
- Create a new topic by providing a topic name (this is also the name of the folder in Elvis) and one or multiple keywords to search for.
- Choose "Save", the topic is now registered with the social import app.
- Check the folder in Elvis for new images.
- Clicking an image will show the details of that image in Twitter panel.
- Click on the image in the panel to go to the tweet
- Click on the Google button to search for similar images in Google
Tip 1: Test with a trending hashtag if you want to validate the installation Tip 2: If either the topic isn't saved or the images are not imported: validate your configuration and check the social import server log for error indicators.
When using media from social networks, you have to make sure to stay within the privacy and usage policies of these networks.
- Twitter support