|
| 1 | +--- |
| 2 | +title: Quick - IDE Login |
| 3 | +icon: IconBook2 |
| 4 | +--- |
| 5 | + |
| 6 | +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; |
| 7 | +import { Callout } from 'fumadocs-ui/components/callout'; |
| 8 | +import { Step, Steps } from 'fumadocs-ui/components/steps'; |
| 9 | +import { Cards, Card } from 'fumadocs-ui/components/card'; |
| 10 | + |
| 11 | +Welcome to the **Quick Tutorials**! In this guide, we’ll walk through all steps from your current installtion to your first flow. |
| 12 | + |
| 13 | +<Callout type="info"> |
| 14 | + **Prerequisite:** Ensure you have completed the steps from the [Installation Process](/general/install) before proceeding. |
| 15 | +</Callout> |
| 16 | + |
| 17 | +<Steps> |
| 18 | +<Step> |
| 19 | + |
| 20 | +To access the IDE, you need to visit the URL defined in your `.env` file. Open your environment configuration to verify the `HOSTNAME` and `PORT`: |
| 21 | + |
| 22 | +```bash title=".env" |
| 23 | +# IDE config |
| 24 | +# [!code highlight:3] |
| 25 | +HOSTNAME=localhost |
| 26 | +HTTP_PORT=80 |
| 27 | +HTTPS_PORT=443 |
| 28 | +SSL_ENABLED=false |
| 29 | +SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem" |
| 30 | +SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key" |
| 31 | + |
| 32 | +INITIAL_ROOT_PASSWORD=myWebPassword |
| 33 | +INITIAL_ROOT_MAIL=tutorials@code0.tech |
| 34 | +INITIAL_RUNTIME_TOKEN= # can be used to create a global runtime with given token |
| 35 | + |
| 36 | +# Runtime config |
| 37 | +AQUILA_SAGITTARIUS_URL=http://nginx:80 |
| 38 | +AQUILA_SAGITTARIUS_TOKEN= |
| 39 | +DRACO_REST_PORT=8084 |
| 40 | +... |
| 41 | +``` |
| 42 | + |
| 43 | +<Tabs items={['Local Access', 'Remote Access']}> |
| 44 | + <Tab value="Local Access"> |
| 45 | + ### Local Machine |
| 46 | + If you are running the ide in docker on your current computer, use the loopback address. |
| 47 | + |
| 48 | + ```text |
| 49 | + http://localhost |
| 50 | + ``` |
| 51 | + |
| 52 | + <Callout type="info"> |
| 53 | + This only works if the browser and the docker container are on the same device. |
| 54 | + </Callout> |
| 55 | + </Tab> |
| 56 | + |
| 57 | + <Tab value="Remote Access"> |
| 58 | + ### Remote Server |
| 59 | + If you are accessing a server on your local network, use the its IP address. |
| 60 | + |
| 61 | + ```text |
| 62 | + http://192.168.2.105 |
| 63 | + ``` |
| 64 | + |
| 65 | + **Instructions:** |
| 66 | + 1. Find your server IP (PS: On linux headless type `ip addr` copy that address). |
| 67 | + 2. Replace `192.168.2.105` with your actual IP. |
| 68 | + 3. Ensure port `80` is open in your firewall settings. |
| 69 | + </Tab> |
| 70 | +</Tabs> |
| 71 | + |
| 72 | +Once you have opened the correct URL in your browser, the login screen will appear. Enter the credentials you defined in your .env file. |
| 73 | + |
| 74 | +```bash title=".env" |
| 75 | +# IDE config |
| 76 | +HOSTNAME=localhost |
| 77 | +HTTP_PORT=80 |
| 78 | +HTTPS_PORT=443 |
| 79 | +SSL_ENABLED=false |
| 80 | +SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem" |
| 81 | +SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key" |
| 82 | + |
| 83 | +# [!code highlight:2] |
| 84 | +INITIAL_ROOT_PASSWORD=myWebPassword |
| 85 | +INITIAL_ROOT_MAIL=tutorials@code0.tech |
| 86 | +INITIAL_RUNTIME_TOKEN= # can be used to create a global runtime with given token |
| 87 | + |
| 88 | +# Runtime config |
| 89 | +AQUILA_SAGITTARIUS_URL=http://nginx:80 |
| 90 | +AQUILA_SAGITTARIUS_TOKEN=A_TOKEN |
| 91 | +DRACO_REST_PORT=8084 |
| 92 | +... |
| 93 | +``` |
| 94 | + |
| 95 | +Enter the `INITIAL_ROOT_MAIL` and `INITIAL_ROOT_PASSWORD` into their corresponding login fields, then click **Login**. |
| 96 | + |
| 97 | + |
| 98 | +</Step> |
| 99 | +</Steps> |
0 commit comments