ReMe/docs/Installation.md

67 lines
No EOL
1.6 KiB
Markdown

# Installing MemoryScope
## I. Install with docker [Recommended]
1. Clone the repository and edit settings
```bash
# clone project
git clone https://...
cd memoryscope
# edit configuration, e.g. add api keys
vim memoryscope/core/config/demo_config.yaml
```
2. Build Docker image
```bash
sudo docker build --network=host -t memoryscope .
```
3. Launch Docker container
```bash
sudo docker run -it --rm --net=host memoryscope
```
## II. Install with docker compose [Recommended]
1. Clone the repository and edit settings
```bash
# clone project
git clone https://...
cd memoryscope
# edit configuration, e.g. add api keys
vim memoryscope/core/config/demo_config.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.
## III. Install in native system [Linux only]
1. Clone the repository and edit settings
```bash
# clone project
git clone https://...
cd memoryscope
# edit configuration, e.g. add api keys
vim memoryscope/core/config/demo_config.yaml
```
2. Install
```bash
poetry install
```
3. Run Elasticsearch service, refer to [elasticsearch documents](https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started.html).
4. Launch memoryscope, also refer to [cli documents](../examples/cli/README.md)
```bash
memoryscope --config_path=memoryscope/core/config/demo_config.yaml
```