|
| 1 | +.. _rm-atlas-log-in: |
| 2 | + |
| 3 | +================= |
| 4 | +Log In with Atlas |
| 5 | +================= |
| 6 | + |
| 7 | +.. contents:: On this page |
| 8 | + :local: |
| 9 | + :backlinks: none |
| 10 | + :depth: 1 |
| 11 | + :class: singlecol |
| 12 | + |
| 13 | +You can sign in to your Atlas account inside Relational Migrator. When |
| 14 | +you log in with your Atlas account in Relational Migrator, you can |
| 15 | +access the :ref:`Query Converter <rm-query-converter>` feature. |
| 16 | + |
| 17 | +Before you Begin |
| 18 | +---------------- |
| 19 | + |
| 20 | +To log in with Atlas, you must have an existing :atlas:`Atlas account |
| 21 | +</tutorial/create-atlas-account>` and a |
| 22 | +:atlas:`deployment </create-connect-deployments>`. |
| 23 | + |
| 24 | +About this Task |
| 25 | +--------------- |
| 26 | + |
| 27 | +- To log in with your Atlas account, Relational Migrator must be running |
| 28 | + on localhost on one of the following ports: |
| 29 | + |
| 30 | + - ``8278`` |
| 31 | + - ``8080`` |
| 32 | + - ``443`` |
| 33 | + |
| 34 | +- If you run Relational Migrator on ports not listed above, |
| 35 | + the sign-in process fails. |
| 36 | + |
| 37 | +- You might need to reauthenticate when your session token expires. To |
| 38 | + reauthenticate to your Atlas account, follow the same log in procedure |
| 39 | + below. |
| 40 | + |
| 41 | +Steps |
| 42 | +----- |
| 43 | + |
| 44 | +.. procedure:: |
| 45 | + :style: normal |
| 46 | + |
| 47 | + .. step:: Select log in option |
| 48 | + |
| 49 | + On the top right of the Relational Migrator home screen, click |
| 50 | + the profile icon or the :guilabel:`Log in` button. The account |
| 51 | + login modal displays. Click the :icon-lg:`LogIn` |
| 52 | + :guilabel:`Log in with Atlas` button. |
| 53 | + |
| 54 | + .. tip:: |
| 55 | + |
| 56 | + You can also initiate the log in process from the |
| 57 | + :guilabel:`Code Generation` tab by clicking the |
| 58 | + :icon-lg:`LogIn` :guilabel:`Log in with Atlas` button on the |
| 59 | + :guilabel:`Query Converter` pane. |
| 60 | + |
| 61 | + .. step:: Enter your Atlas account credentials |
| 62 | + |
| 63 | + Enter your :guilabel:`Email Address` and :guilabel:`Password`, |
| 64 | + then click :guilabel:`Log in`. |
| 65 | + |
| 66 | + .. step:: (Optional) Log out of Atlas account |
| 67 | + |
| 68 | + Click on the profile icon on the top right and click |
| 69 | + :icon-lg:`LogOut` :guilabel:`Log Out` to log out of your Atlas |
| 70 | + account. |
| 71 | + |
| 72 | +Next Steps |
| 73 | +---------- |
| 74 | + |
| 75 | +- :ref:`rm-enable-query-converter` |
| 76 | +- :ref:`rm-convert-queries` |
| 77 | + |
| 78 | +Learn More |
| 79 | +---------- |
| 80 | + |
| 81 | +- :atlas:`Create an Atlas Cluster </create-database-deployment/#clusters>` |
0 commit comments