First steps

Phrase On-Premise first steps

Phrase On-Premise first steps

This guide explains the first steps with Phrase On-Premise and requires that you have successfully completed the installation and you can see the Phrase On-Premise login page, when you open your installation’s $BASE_URL in a browser:

Accessing the Phrase On-Premise Translation Center in your browser

1. Open your web browser

2. Go to the $BASE_URL  of your Phrase On-Premise installation

Replace $BASE_URL wherever it occurs in this guide with your configured domain, protocol and scheme for your local installation. For testing purposes this can be the IP of your $DOCKER_HOST  and the port you configured the Phrase On-Premise container to listen on using the -p 8080:8080 -flag with the docker run -command. If you try to access Phrase On-Premise from another computer in your network, make sure that the bound interface is exposed on the Docker host, e.g. via a local web server such as Apache or Nginx. This local web server could also handle SSL termination if necessary for your setup.

Creating a first account and project

1. Open Phrase On-Premise Translation Center in your browser

2. Follow the sign-up-link labeled “Don’t have an Account? Sign-up.”

3. Fill out and submit the sign-up form to create a new account

4. Follow the onboarding wizard steps to create a first project

You can later create more accounts and projects. If you do not see any sign-up link but only a login form, we suggest that you check the SIGNUPS_DISABLED  environment variable and set it to 0 to enable the creation of at least one initial Phrase On-Premise Account when installing the Phrase On-Premise container.

1. Make sure, that emails can be sent out by the system successfully by inviting a team-member to your project and verifying with her that she received the email in her inbox.

The different features of the Translation Center are explained in our help center.

Setup your development environment with the Phrase CLI client

1. Sign in to the Translation Center

2. Create an access token

To create a personal API access token, open the dropdown menu in the upper-right corner of the screen by clicking on your username. Select “Access tokens” > Click the button with the plus-symbol to create an access token. Name your access token, in order to be able to identify it later. Copy the access token, it will never again be shown in the Translation Center, but you can always create a new one

3. Install the Phrase CLI tool

Download and link the appropriate executable for your development system. On OS X you can install the phraseapp client using homebrew when adding our phraseapp formula repository

$ brew tap phrase/brewed
$ brew install phrase

4. Open your command line (e.g. terminal or iterm on OS X)

5. Go to the root folder of your application’s source code

6. Initialize your project configuration

$ phrase init --host $BASE_URL/api

Enter the access token you created earlier when asked to.

Replace $BASE_URL  with the actual host or domain name of your application, e.g. https://phraseapp.mycomany.tld.

7. Follow the steps of the init-wizard to set up your project configuration

After successfully completing the init-wizard, the wizard will create a .phraseapp.yml file inside your code repository. See the Phrase configuration guide for available configuration options.

If you remove the access_token from the .phraseapp.yml  you can safely commit this file to your source code management. You can either specify the --access_token argument on every phraseapp-command call or you can set a local environment variable $PHRASEAPP_ACCESS_TOKEN  with the value of the access token for your user which the phrase-command will then use for authentication.

If phrase init  should fail to load any project, make sure you have created at least one project and that you can access your Phrase On-Premise installation, e.g. by listing all projects:

$ phrase projects list --access_token $PHRASEAPP_ACCESS_TOKEN \
 --host http://$BASE_URL/api

Besides our CLI client there are many IDE plugins and framework adapters that can be configured to be used with Phrase On-Premise. Ask our Support for details.