From 532314e6e8c14f652c20e524879702ce58828c98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9D=92=E8=BD=A9?= Date: Thu, 18 Jul 2024 15:52:42 +0800 Subject: [PATCH] update docker run readme --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75177bc6..5e8c0fb7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,51 @@ English | [**中文**](./README_ZH.md) -# ModelScope \ No newline at end of file +# MemoryScope + + +# Installation + +## (1) Docker-Compose (Recommanded) +1. Clone the project and edit the config. + + ``` + git clone https://... + nano config/demo_config_cn.yaml + ``` + +2. Edit `docker-compose.yml` to change environment variable. + + ``` + DASHSCOPE_API_KEY: "sk-0000000000" + ``` + +3. Run `docker-compose up` to build and launch the memory-scope cli interface. + + +## (2) Docker + +1. Clone the project and edit the config. + + ``` + git clone https://... + nano config/demo_config_cn.yaml + ``` + +2. Build the `Dockerfile` with command: + ``` + sudo docker build --network=host -t memoryscope . + ``` + +3. Run `ElasticSearch` Container with command: + ``` + docker run -p 9200:9200 \ + -e "discovery.type=single-node" \ + -e "xpack.security.enabled=false" \ + -e "xpack.license.self_generated.type=trial" \ + docker.elastic.co/elasticsearch/elasticsearch:8.13.2 + ``` + +4. Launch the built image with command: + ``` + sudo docker run -it --rm --net=host memoryscope + ``` \ No newline at end of file