Keep in mind these instructions assume you already have an account with Linode.com. If you do not have an account, please create one here.
The first step in getting the Manager running locally is to create an OAuth Client. You can create one here. On this screen, click Create an OAuth App
Once the drawer opens up, open the values below and click Submit
Finally, keep the client ID in the table row handy. You'll need it later:
Please refer to the .env.example file in this directory. This will get you started in creating you own .env file so you can run the Manager.
Here are a list of all the required and optional environment variables the Manager leverages:
REACT_APP_APP_ROOT: The root location where you will be running the app
- e.g.
http://localhost:3000
REACT_APP_LOGIN_ROOT: The root location where users will authenticate
- e.g.
https://login.linode.com
REACT_APP_API_ROOT: The root location where API requests will be made
- e.g.
https://api.linode.com/v4
REACT_APP_LIST_ROOT: The root location of LISH, Linode's web-based console
- e.g.
webconsole.linode.com
REACT_APP_CLIENT_ID: The Client ID you created above in the first step
REACT_APP_ALGOLIA_APPLICATION_ID: The ID that matches with the Algolia index
REACT_APP_SEARCH_KEY: The search key that matches with the Algolia index
REACT_APP_SENTRY_URL: The URL to a configured Sentry environment
REACT_APP_GA_ID: The ID that matches with a configured Google Analytics property
REACT_APP_GTM_ID: The ID that matches with a configured Google Tag Manager property
REACT_APP_ACCESS_TOKEN: Access Token that overrides the token recieved from the Login service.
e.g Bearer 1232313 or Admin 1231423
REACT_APP_DISABLE_EVENT_THROTTLE: Whether the app should poll the /events endpoint at provided intervals
These are environment variables that can be used for automated testing processes
MANAGER_USER: Username of the account on which end-to-end tests should run
MANAGER_PASS: Password of the account on which end-to-end tests should run
MANAGER_OAUTH: OAuth Token of the account on which end-to-end tests should run
Running the app requires a working Node environment to be installed. We recommend you
install some version greater than 8.11.2
We are also utilizing Yarn in this project, so be sure to install the latest stable version.
Once these dependencies are installed, run the following command
yarn && yarn start
alternatively, with Docker
yarn && yarn docker:local
At this point, the app should load on localhost:3000 and you should be prompted to login and then can start browsing the app.