Compare commits
4 الالتزامات
0362379f4a
...
cfa09f6271
المؤلف | SHA1 | التاريخ | |
---|---|---|---|
cfa09f6271 | |||
aa49f9b478 | |||
16b14fc501 | |||
c1cd7a6091 |
@@ -1,4 +1,4 @@
|
|||||||
## What is an Application?
|
# What is an Application?
|
||||||
|
|
||||||
When working with the Ghaymah CLI, an **Application** is the central resource you’ll interact with.
|
When working with the Ghaymah CLI, an **Application** is the central resource you’ll interact with.
|
||||||
It’s not just source code it’s a deployable unit wrapped in a container, ready to run anywhere.
|
It’s not just source code it’s a deployable unit wrapped in a container, ready to run anywhere.
|
||||||
@@ -11,44 +11,88 @@ Everything else like containers, configs, and logs revolves around it.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gy resource app [command]
|
gy resource app [command]
|
||||||
```
|
```
|
||||||
|
|
||||||
Aliases: app, a
|
Aliases: app, a
|
||||||
|
|
||||||
> **Tip:** You can use -h or --help to see all available options.
|
> **Tip:** You can use -h or --help to see all available options.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gy resource app --help
|
gy resource app --help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## creating an application
|
## creating an application
|
||||||
|
|
||||||
### step 1: Initialize the Application
|
### step 1: Initialize the Application
|
||||||
|
|
||||||
Run the following command to create a new application:
|
Run the following command to create a new application:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gy resource app init -p project_id
|
gy resource app init -p project_id
|
||||||
```
|
```
|
||||||
|
|
||||||
>If you don’t know your project ID or haven’t created a project yet, see the [Projects](Project.md) documentation.
|
>If you don’t know your project ID or haven’t created a project yet, see the [Projects](Project.md) documentation.
|
||||||
|
|
||||||
#### Flags
|
#### Flags
|
||||||
|
|
||||||
| Flag | what does it do | comment |
|
| Flag | what does it do | comment |
|
||||||
| ------------- | ------------------------- | ------------------------------------ |
|
| ------------- | ------------------------- | ------------------------------------ |
|
||||||
| -p project_id | specifies the project id | required |
|
| -p project_id | specifies the project id | required |
|
||||||
| -n name | Sets the application name | Optional, defaults to directory name |
|
| -n name | Sets the application name | Optional, defaults to directory name |
|
||||||
### Step 2: Deploy the Application
|
|
||||||
#### deploying from a Dockerfile
|
### Step 2: deploying from a Dockerfile
|
||||||
|
|
||||||
To deploy using a **Dockerfile**, ensure that:
|
To deploy using a **Dockerfile**, ensure that:
|
||||||
|
|
||||||
- A `Dockerfile` exists in the project directory.
|
- A `Dockerfile` exists in the project directory.
|
||||||
- All necessary files referenced by the `Dockerfile` are present in the same directory.
|
- All necessary files referenced by the `Dockerfile` are present in the same directory.
|
||||||
|
|
||||||
Once these requirements are met, deploy the application with:
|
Once these requirements are met, deploy the application with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gy resource app launch
|
gy resource app launch
|
||||||
```
|
```
|
||||||
#### Deploying from a git repository
|
|
||||||
## Configuring the .ghaymah.json
|
## Configuring the .ghaymah.json
|
||||||
|
|
||||||
|
Example `.ghaymah.json`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "ac2d8eb7-ff49-4b8d-9a8e-92cd3aae22a6",
|
||||||
|
"name": "nginx",
|
||||||
|
"projectId": "b887e332-3ecd-4187-bdfb-17d8a437833e",
|
||||||
|
"ports": [
|
||||||
|
{
|
||||||
|
"expose": true,
|
||||||
|
"number": 80
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"publicAccess": {
|
||||||
|
"enabled": true,
|
||||||
|
"domain": "auto"
|
||||||
|
},
|
||||||
|
"resourceTier": "t1",
|
||||||
|
"dockerFileName": "Dockerfile"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Changing values
|
||||||
|
|
||||||
|
You can change **name**, exposed port, and **dockerFileName** freely.
|
||||||
|
>you can only have one port per application.
|
||||||
|
>
|
||||||
|
### Adding environment variables
|
||||||
|
|
||||||
|
Add an `env` object to the top-level JSON.Example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"env": {
|
||||||
|
"foo": "bar",
|
||||||
|
"port": 8080
|
||||||
|
}
|
||||||
|
```
|
||||||
|
@@ -1,6 +1,4 @@
|
|||||||
- [Getting Started](getting-started.md)
|
- [Getting Started](getting-started.md)
|
||||||
|
|
||||||
- Features
|
|
||||||
<!-- - [Integrations](features/integrations.md) -->
|
<!-- - [Integrations](features/integrations.md) -->
|
||||||
- [Projects](Project.md)
|
- [Projects](Project.md)
|
||||||
- [Application](Application.md)
|
- [Application](Application.md)
|
||||||
|
@@ -7,8 +7,14 @@ This topic describes how to install the latest release of **Ghaymah Command Line
|
|||||||
## Ghaymah CLI Install Instructions
|
## Ghaymah CLI Install Instructions
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
<!-- tabs:start -->
|
||||||
|
|
||||||
#### **Step 1:** Download & Install
|
#### **Linux**
|
||||||
|
<!-- tabs:start -->
|
||||||
|
|
||||||
|
#### **Debian**
|
||||||
|
|
||||||
|
Download & Install
|
||||||
|
|
||||||
Run the following command to install the latest release of the Ghaymah CLI:
|
Run the following command to install the latest release of the Ghaymah CLI:
|
||||||
|
|
||||||
@@ -16,7 +22,17 @@ Run the following command to install the latest release of the Ghaymah CLI:
|
|||||||
curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 2:** Update PATH
|
#### **Redhat**
|
||||||
|
|
||||||
|
1.Download & Install
|
||||||
|
|
||||||
|
Run the following command to install the latest release of the Ghaymah CLI:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
2.update PATH
|
||||||
|
|
||||||
Add the CLI to your PATH and reload your shell configuration:
|
Add the CLI to your PATH and reload your shell configuration:
|
||||||
|
|
||||||
@@ -25,7 +41,18 @@ echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
|
|||||||
source ~/.bashrc
|
source ~/.bashrc
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 3:** Verify Installation
|
<!-- tabs:end -->
|
||||||
|
|
||||||
|
#### **Macos**
|
||||||
|
|
||||||
|
Bonjour!
|
||||||
|
|
||||||
|
#### **Windows**
|
||||||
|
|
||||||
|
Ciao!
|
||||||
|
|
||||||
|
<!-- tabs:end -->
|
||||||
|
### Verifying Installation
|
||||||
|
|
||||||
Check that the CLI is installed correctly:
|
Check that the CLI is installed correctly:
|
||||||
|
|
||||||
|
@@ -32,8 +32,10 @@
|
|||||||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
|
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
|
||||||
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
|
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
|
||||||
|
|
||||||
<!-- Recommended -->
|
Recommended
|
||||||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
|
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
|
||||||
|
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
</html>
|
</html>
|
المرجع في مشكلة جديدة
حظر مستخدم