Amazon Translate - Advanced Neural Machine Translation Documentation

Requirements

Before installation, your server must have following requirements to run the script properly

• PHP v7.4 or higher
• PHP Mbstring Extension
• PHP PDO Extension
• PHP JSON Extension
• PHP CURL Extension
• Support for MySQL v5.x

Installation Instructions

This is a general installation overview of the script, there is a deep dive section provided for each part in the left menu bar.

Follow the steps as explained, and you should be all set. If you face any challenges with installtion steps, reach out to us for a support.

Setup overview:

• Step 1: Unzip and upload only the contencts of cloudtranslate to the root directory of your hosting server- Ex: /home/username/public_html/. Which will make it reachable as follows: http://yourwebsitename/
• Step 2: Make sure your domainname points to the public folder only. So in your settings, path for your domain must be: htts://yourwebsitename/public. In case if you don't point your domain to public folder, we also include custom .htaccess file in the root directory for your convenience, it will automatically point requests to public directory in the script.
• Step 2a: Warning! Some hosting platform hide files starting with '.' (hidden files), so make sure that in your settings of your cPanel you enable this option.
• Step 2b: Warning! If your local Windows/Linux/MaxOS environment does not show hidden files, and you are planning to upload the script via FTP, make sure you enable viewing hidden files locally first even before unzipping, otherwise you will not upload all hidden files such as .env/.htaccess to your FTS server simply because your local environment will not see them.
• Step 3: Everything inside of the public folder is accessible by anyone, so make sure you don't put anything sensitive there such as google json keys, etc.
• Step 4: After uploading all files and making sure that domain name has proper path set, create Mysql Database and proper user in case if you don't already have one, to access this database. You can either create manually via your phpMyAdmin panel or use phpMyAdmin Wizard in your cPanel to create one.
• Step 5: Now you are ready to run the install script. Go to https://yourwebsitename/install or if you skipped Step 2, go to https://yourwebsitename/public/install.
• Step 6: This will start the installation process, click Start Intallation button.
• Step 7: Make sure required php packages are installed and enabled on your server. Click Next to continue.
• Step 8: Make sure listed folder are publicly accessbile. Click Next to continue.
• Step 9: For database configuration, enter your newly created database credentials (it is highly recommended to use randomly generated password). DB Server: localhost, unless your database resides somewhere else. MySQL DB Port: 3306, unless you are using some other port.
• Step 10: On the final step enter your Envato License key for this product and also your Envato Username. In case if you don't know where to get your license, you can check this article.
• Step 11: After installation is complete, you are now fully ready to start. The default login name is: admin@example.com and default password is: admin12345. You can change it after loggin in in your profile settings.
• Step 12: Login as admin and configure SMTP Settings under Admin Panel - General Settings - SMTP Settings. Make sure your SMTP settings work by sending a test email. Without correct SMTP settings, you cannot activate email verification feature for new users.
• Step 13: To start using Cloud Translate features, enter AWS API Keys and a Bucket Name under Admin Panel - Translate Management - Translate Configuration. Important! You will also need to create a specific IAM Role ARN to be able to use this script. Follow the documentation under AWS Setup tab under Role ARN Setup option.
• Step 14: To get all your translate results from AWS, setting up CRON Job correctly is very important. Warning: Every hosting has different CRON setup/configuration options. under the CRON Job Setup tab on left, we included instructions based on our hosting provider Namecheap. Our hosting doesn't allow to create CRON tasks in 1 minute internal (only 5 minutes), but if yours does allow, for user experience it is highly recommended to set CRON task running schedule to be in 1 Minute Interval. Otherwise set whichever is the minimum allowed value in your hosting.

Database Setup in phpMyAdmin

To run admin panel properly and fetch the application useage data and to set the settings you will need to setup MySQL database 5.7.

How to create new Database in phpMyAdmin:

• Step 1: Login into phpMyAdmin.
• Step 2: Click on New button to create a new database.
  
• Step 3: Provide database name and select utf8_general_ci as collation and click create button.
  
• Step 4: Make sure you have database user who can access this newly created database, if not you will need create one with all permissions and set a password
• Step 5: Also, to avoid any issues with database setup, make sure your newly created database has InnoDB set as storage type
• Step 6: Return to the Install process and enter your newly created database credentials. If using local server, you can set database host to localhost, and for mysql port use 3306

AWS Account Creation

Getting started with AWS. If you already have AWS Account, skip to next section.

How to Create AWS Account:

• Step 1: Open the Amazon Web Services home page.
• Step 2: Choose Create an AWS Account.
  Note: If you signed in to AWS recently, choose Sign in to the Console. If Create a new AWS account isn't visible, first choose Sign in to a different account, and then choose Create a new AWS account.
• Step 3: Enter your account information, and then choose Continue. Be sure that you enter your account information correctly, especially your email address. If you enter your email address incorrectly, you can't access your account.
• Step 4: Choose Personal or Professional.
  Note: Personal accounts and professional accounts have the same features and functions.
• Step 5: Enter your company or personal information.
  Important: For professional AWS accounts, it's a best practice to enter the company phone number rather than a personal cell phone. Configuring a root account with an individual email address or a personal phone number can make your account insecure.
• Step 6: Read and accept the AWS Customer Agreement.
  Note: Be sure that you read and understand the terms of the AWS Customer Agreement.
• Step 7: Choose Create Account and Continue.
• Step 8: On the Payment Information page, enter the information about your payment method, and then choose Verify and Add.
  Note: If you want to use a different billing address for your AWS billing information, choose Use a new address before you choose Verify and Add
  Important: You can't proceed with the sign-up process until you add a valid payment method.
• Step 9: Verify your phone number. Enter a phone number where you can be reached in the next few minutes.
• Step 10: In a few moments, an automated system contacts you.
• Step 11: Enter the PIN you receive, and then choose Continue.
• Step 12: On the Select a Support Plan page, choose one of the available Support plans. For a description of the available Support plans and their benefits, see Compare AWS Support plans.
• Step 13: After you choose a Support plan, a confirmation page indicates that your account is being activated. Accounts are usually activated within a few minutes, but the process might take up to 24 hours.
• Step 14: You can sign in to your AWS account during this time. The AWS home page might display a Complete Sign Up button during this time, even if you've completed all the steps in the sign-up process.
• Step 14: When your account is fully activated, you receive a confirmation email. Check your email and spam folder for the confirmation email. After you receive this email, you have full access to all AWS services.

AWS IAM User Creation

You will need IAM user with programmatic access and with Transcribe and also S3 Read & Write Policies attached.

Creating AWS IAM Users (via AWS Console):

• Step 1: Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/.
• Step 2: In the navigation pane, choose Users and then choose Add user.
• Step 3: Type the user name for the new user. This is the sign-in name for AWS.
  Note: User names can be a combination of up to 64 letters, digits, and these characters: plus (+), equal (=), comma (,), period (.), at sign (@), and hyphen (-). Names must be unique within an account.
• Step 4: Select the type of access this set of users will have. Select programmatic access.
• Step 5: Choose Next: Permissions.
• Step 6: On the Set permissions page, specify how you want to assign permissions to this set of new users. Choose Attach existing policies to user directly
• Step 7: Seach for AmazonS3FullAccess and TranslateFullAccess, select both afterwards select click Next: Review
  Note: If you are familar with IAM Policies, you can create custom policy that will match your needs and security requirements.
• Step 8: To view the users' access keys (access key IDs and secret access keys), choose Show next to each password and access key that you want to see. To save the access keys, choose Download .csv and then save the file to a safe location.
  Important: This is your only opportunity to view or download the secret access keys, and you must provide this information to your users before they can use the AWS API. Save the user's new access key ID and secret access key in a safe and secure place. You will not have access to the secret keys again after this step.
• Step 9: Include your Access Key and Secret Access Key to the AWS Credentials Settings tab in the admin panel as shown below.

Under Admin -> Translate Management -> Translate Configuration -> AWS, include your Access and Secret Access Keys:

Amazon S3 Bucket Creation

You will need an S3 Bucket with public read & write access in the region that you prefer.

A bucket is owned by the AWS account that created it. By default, you can create up to 100 buckets in each of your AWS accounts. If you need additional buckets, you can increase your account bucket limit to a maximum of 1,000 buckets by submitting a service limit increase. For information about how to increase your bucket limit, see AWS Service Limits

Important: File translation is supported in the following AWS Regions, so make sure you create you bucket in one of them:

• US East (N. Virginia)
• US East (Ohio)
• US West (Oregon)
• Asia Pacific (Seoul)
• Europe (Frankfurt)
• Europe (Ireland)
• Europe (London)

Create an S3 bucket:

• Step 1: Sign in to the AWS Management Console and open the Amazon S3 console at https://console.aws.amazon.com/s3/.
• Step 2: Choose Create bucket.
  
• Step 3: Enter Bucket Name and Select AWS Region where you would like to store your files and click Next. Note: Bucket name must be unique at a global level.
  
• Step 4: In the Set Permissions step, you need to turn off all 4 options if you want to make your S3 bucket completely public.
  
• Step 5: Review rest of the settings, or you can leave them as they are and click Create Bucket.
• Step 6: Include your Bucket Name and Select your AWS Region in the AWS Credentials Settings tab in the admin panel as shown below.

Under Admin Panel -> Translate Management -> Translate Configuration -> AWS, include your S3 Bucket Name and select your AWS Region where bucket is hosted:

Amazon S3 Bucket Configuration

After successfully creating a bucket, add these addtional features for your S3 bucket.

Check these 6 steps:

• Step 1: Make sure your Permissions -> Block Public Access looks at least like this and has all 4 options turned off.
  
• Step 2: Add CORS settings as shown below in the Permissions -> Cross-origin resource sharing (CORS) Configuration section and click Save.
  
  

  Copy paste these CORS settings to your bucket:

  [
      {
          "AllowedHeaders": [
              "*"
          ],
          "AllowedMethods": [
              "POST",
              "PUT",
              "GET",
              "HEAD",
              "DELETE"
          ],
          "AllowedOrigins": [
              "*"
          ],
          "ExposeHeaders": [
              "ETag"
          ],
          "MaxAgeSeconds": 30000
      }
  ]
  

• Step 3: Go to your newly created S3 Bucket click on Permissions -> Object Ownership and click Edit.
  
• Step 4: Select ACLs enabled and Object writer and click Save Changes.
  
• Step 5: To make your bucket fully public, Go to Permissions -> Bucket Policy and click Edit.
• Step 6: Copy paste this bucket policy below and change YOURBUCKETNAME with your bucket and click Save Changes.

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "CLOUDTRANSLATE",
              "Effect": "Allow",
              "Principal": {
                  "AWS": "*"
              },
              "Action": [
                  "s3:GetObject",
                  "s3:DeleteObject",
                  "s3:PutObject"
              ],
              "Resource": "arn:aws:s3:::YOURBUCKETNAME/*"
          }
      ]
  }