44[ ![ Go Report Card] ( https://goreportcard.com/badge/github.com/mayooot/gpu-docker-api )] ( https://goreportcard.com/badge/github.com/mayooot/gpu-docker-api )
55
66[ 简体中文] ( docs%2Fzh-cn.md )
7+ > ⚠️注意:中文文档已经过期,请使用英文文档。
8+ >
79
810# Overview
911
@@ -22,9 +24,12 @@ Similar to the operation on container instances in [AutoDL](https://www.autodl.c
2224 - [ GPU] ( #gpu )
2325 - [ Port] ( #port )
2426- [ Quick Start] ( #quick-start )
25- - [ API] ( #api )
27+ - [ Import API] ( #import- api )
2628 - [ Environmental Preparation] ( #environmental-preparation )
27- - [ Build from Source] ( #build-from-source )
29+ - [ Build From Source] ( #build-from-source )
30+ - [ Download From Release] ( #download-from-release )
31+ - [ Config File] ( #config-file )
32+ - [ Run] ( #run )
2833- [ Architecture] ( #architecture )
2934 - [ Component Introduction] ( #component-introduction )
3035 - [ Architecture Diagram] ( #architecture-diagram )
@@ -95,7 +100,7 @@ The same is true when updating volume.
95100
96101[ 👉 Click here to see, my environment] ( #Environment )
97102
98- ## API
103+ ## Import API
99104
100105Import [ gpu-docker-api.openapi.json] ( api%2Fgpu-docker-api.openapi.json ) to invoke api.
101106
@@ -113,23 +118,41 @@ Import [gpu-docker-api.openapi.json](api%2Fgpu-docker-api.openapi.json) to invok
113118 tutorial: [ ETCD] ( https://github.com/etcd-io/etcd ) .
1141195 . Clone and run [ detect-gpu] ( https://github.com/mayooot/detect-gpu ) .
115120
116- ## Build from source
121+ ## Build From Source
117122
118- ### Build
123+ ~~~
124+ $ git clone https://github.com/mayooot/gpu-docker-api.git
125+ $ cd gpu-docker-api
126+ $ make build
127+ ~~~
128+
129+ ## Download From Release
130+ [ release] ( https://github.com/mayooot/gpu-docker-api/releases )
131+
132+ ## Config File
133+
134+ If you download the executable file from [ release] ( https://github.com/mayooot/gpu-docker-api/releases ) ,
135+ you should download ` config.toml ` by hand and create the ` etc ` directory.
136+
137+ The directory structure is as follows:
119138
120139~~~
121- git clone https://github.com/mayooot/gpu-docker-api.git
122- cd gpu-docker-api
123- make build
140+ $ tree
141+ .
142+ ├── etc
143+ │ └── config.toml
144+ └── gpu-docker-api-linux-amd64
145+
146+ 1 directory, 2 files
124147~~~
125148
126- ### Modify configuration file (optional)
149+ Then change it the way you want it.
127150
128151~~~
129152vim etc/config.yaml
130153~~~
131154
132- ### Run
155+ ## Run
133156
134157~~~
135158./gpu-docker-api-${your_os}-amd64
0 commit comments