@@ -35,8 +35,7 @@ application on the go.
3535## Contributing
3636
3737In order to contribute, please follow the
38- [ Contributing Guidelines] (
39- https://github.com/scality/Guidelines/blob/master/CONTRIBUTING.md ).
38+ [ Contributing Guidelines] ( https://github.com/scality/Guidelines/blob/master/CONTRIBUTING.md ) .
4039
4140## Installation
4241
@@ -49,12 +48,12 @@ Building and running the Zenko CloudServer requires node.js 10.x and yarn v1.17.
4948### Clone source code
5049
5150``` shell
52- git clone https://github.com/scality/S3 .git
51+ git clone https://github.com/scality/cloudserver .git
5352```
5453
5554### Install js dependencies
5655
57- Go to the ./S3 folder,
56+ Go to the ./cloudserver folder,
5857
5958``` shell
6059yarn install --frozen-lockfile
@@ -69,6 +68,14 @@ If you get an error regarding level-down bindings, try clearing your yarn cache:
6968yarn cache clean
7069```
7170
71+ #### Install typescript
72+
73+ To use CloudServer, subaclient is needed. This package need typescript to be compiled.
74+
75+ ``` shell
76+ npm install -g typescript
77+ ```
78+
7279## Run it with a file backend
7380
7481``` shell
@@ -85,8 +92,8 @@ a secret key of verySecretKey1.
8592By default the metadata files will be saved in the
8693localMetadata directory and the data files will be saved
8794in the localData directory within the ./S3 directory on your
88- machine. These directories have been pre-created within the
89- repository. If you would like to save the data or metadata in
95+ machine. These directories have been pre-created within the
96+ repository. If you would like to save the data or metadata in
9097different locations of your choice, you must specify them with absolute paths.
9198So, when starting the server:
9299
@@ -98,6 +105,17 @@ export S3METADATAPATH="$(pwd)/myFavoriteMetadataPath"
98105yarn start
99106```
100107
108+ ## Run it with a memory backend
109+
110+ If you want to run the Zenko CloudServer with an in-memory backend,
111+ you can do so by setting the ` S3DATA ` environment variable to ` memory ` .
112+ This is useful for testing purposes or when you don't need persistent storage.
113+
114+ ``` shell
115+ export S3DATA=mem
116+ yarn start
117+ ```
118+
101119## Run it with multiple data backends
102120
103121``` shell
0 commit comments