- Clone the latest code or select a released version.
- Generate the configuration file: Copy
env.yaml.tpl
and rename it toenv.yaml
. - Modify the configuration file: Edit
env.yaml
and add the necessary information such as GPT Token . - Run the service: Execute
sh run.sh
on Linux or Mac, or double-clickrun.bat
on Windows. - Access the service: Access the service through a browser (check the startup log for the access address, default is http://127.0.0.1:8080).
- Complete requirement development: Follow the instructions on the page to complete requirement development, and view the generated code in the
./workspace
directory.
- FRONTEND_PORT, BACKEND_PORT: Frontend and backend ports.
- AICODER_ALLOWED_ORIGIN: Allowed cross-origin addresses for the backend, matching the frontend's access address. Note: If you're not accessing the website via 127.0.0.1, manually modify
apiUrl
in frontend/static/js/coder.js. - LANGUAGE: Language.
- LLM_MODEL: Model.
- GPT_KEYS: Keys for GPT, configure OpenAI and Azure API information (replace sk-xxxx with your key). If you don't need a certain type of API, delete the corresponding element entirely (openai/azure). Note: Do not add a comma after the last element in the array. You might need to use a global proxy to access the API.
- USERS: Login user configuration.
DevOpsGPT supports integration with Git. When enabled, development tasks can pull and push code from Git.
- GIT_ENABLED: Enable Git.
- GIT_URL: Configure your Git address, e.g., https://github.com, https://gitlab.com.
- GIT_TOKEN: Configure your Git token, obtainable from here: https://github.com/settings/tokens, https://gitlab.com/-/profile/personal_access_tokens.
- GIT_USERNAME: Git login username.
- GIT_EMAIL: Git email.
- APPS.service.git_path: Git path corresponding to the application, including the group, e.g., kuafuai/template_freestyleApp.
DevOpsGPT supports integration with CI tools like GitlabCI, GithubActions, etc., triggering your pipeline upon code submission.
video: https://www.youtube.com/watch?v=7ZnrHo_brv4
- Complete the "Git Configuration" section above.
- GIT_API: Configure the Git API address, e.g., https://api.github.com.
- If using Gitlab, set up the pipeline, e.g., .gitlab-ci.yml. Also, configure Gitlab runner in Gitlab, details in the Gitlab documentation.
- If using Github, set up the pipeline, e.g., default.yaml. Refer to the Github documentation for details.
Automated deployment implementations Deploy developed applications to a cloud service in one click for all to access and use, truly moving from natural language requirements to working software!
video: https://www.youtube.com/watch?v=3peUJeB_afo
The following uses Alibaba Cloud as an example to describe the configuration, similar to other cloud platforms, note: the use of cloud platform resources may incur a small fee.
- Create an AccessKey on the cloud platform: Move the mouse to the avatar - Select AccessKey Management - Create an AccessKey
- From the Kay created above, configure CD_ACCESS_KEY and CD_SECRET_KEY
- CD_REGION: Set the deployment area, such as deployment to Hong Kong, can be configured as: cn-hongkong, please consult the cloud platform customer service
- CD_EIP: Create a public IP address on the cloud platform for accessing the public network (the region must match CD_REGION).
- CD_SECURITY: Create a security group on the cloud platform to enable external ports when services are started
- CD_SWITCH:Create a switch on the cloud platform
APPS contains information about the applications you need to develop. The first step in using the product is selecting a development application. During development, this information guides how the application should be designed and developed. In the open-source version, this information needs to be maintained manually. We'll provide AI intelligent analysis to automatically generate relevant information in the commercial version.
- app: Application, including multiple services like backend, frontend, microservices.
- name, intro: Display purposes only.
- service.name: Service name, must be unique.
- service.git_workflow: Github workflow name, effective only when Github CI is enabled.
- service.git_path: Git path, should include group, e.g., kuafuai/template_freestyleApp.
- service.base_prompt: Basic starting prompt, affects task development effectiveness.
- service.intro: Basic information about the service.
- setpReqChooseLib (analysis of libraries/packages used together with service information).
- service.api_doc_url: API documentation URL, used to dynamically retrieve API documentation.
- service.api_doc: Current API documentation.
- service.struct: File directory structure information for the service.
- setp1Task (used for breaking down tasks).
- service.lib: Libraries/packages available for the service.
- setpReqChooseLib (analysis of libraries/packages used together).
- service.specification: Specification for using library packages.