Vacant2333 commented on code in PR #10899: URL: https://github.com/apache/apisix/pull/10899#discussion_r1475610974
########## docs/en/latest/develop-apisix-environment.md: ########## @@ -0,0 +1,98 @@ +--- +id: develop-apisix-environment +title: Rapid construction development environment by Docker +description: This article introduces how to quickly build the development environment of the Apache APISIX API gateway using Docker. +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +If you wish to quickly build and develop APISIX on your system, you can refer to this tutorial. + +:::note + +This tutorial is suitable for situations where you need to quickly get started with introductory development. If you want to take further steps for a better development experience, a preferable option is a Linux-based virtual machine or directly using such systems as your development environment. + +You can see the specific supported systems [here](install-dependencies.md#install). + +::: + +## Quick Setup of Apache APISIX Development Environment + +### Implementation Idea + + + +### Implementation Steps + +First, we need to clone the APISIX source code, build an image that can run test cases, and compile the Apache APISIX. + +```shell +git clone https://github.com/apache/apisix.git +cd apisix +docker build -t apisix-dev-env -f example/build-dev-image.dockerfile . +``` + +Then, we need to start Etcd: + +```shell +docker run -d --name etcd-apisix --net=host pachyderm/etcd:v3.5.2 +``` + +Mount the APISIX directory and start the development environment container. + +```shell +docker run -d --name apisix-dev-env --net=host -v $(pwd):/apisix:rw apisix-dev-env:latest +``` + +Finally, enter the container, build the Apache APISIX runtime, and configure the test environment. + +```shell +docker exec -it apisix-dev-env /bin/bash + +make deps +ln -s /usr/bin/openresty /usr/bin/nginx +``` + +### Start Using: + +#### Run and Stop APISIX + +```shell +make run +make stop +``` + +:::note + +If you encounter an error message like `nginx: [emerg] bind() to unix:/apisix/logs/worker_events.sock failed (95: Operation not supported)` while running `make run`, please use this solution. + +Change the `File Sharing` settings of your `Docker-Desktop`: Review Comment: hi kayx! Answer: This tutorial is suitable for the quick start stage. If someone only uses `docker engine`, it may not need this tutorial. For beginners, it usually uses `docker desktop`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
