From ff0caab33af0e852992de59c8e640fd4b555845a Mon Sep 17 00:00:00 2001 From: Ewgenij Katchko Date: Wed, 11 Dec 2019 22:31:22 +0100 Subject: [PATCH] update readme, x-forc-key in .env --- .env | 1 - .env.in | 2 ++ .gitignore | 2 +- README.md | 8 ++++++-- docker-compose.yml | 1 + 5 files changed, 10 insertions(+), 4 deletions(-) delete mode 100644 .env create mode 100644 .env.in diff --git a/.env b/.env deleted file mode 100644 index aec741a1..00000000 --- a/.env +++ /dev/null @@ -1 +0,0 @@ -CLOUD_CLIENT_TAG=0.1.0-beta.0.7.4 diff --git a/.env.in b/.env.in new file mode 100644 index 00000000..b3724143 --- /dev/null +++ b/.env.in @@ -0,0 +1,2 @@ +CLOUD_CLIENT_TAG= +FORC_API_KEY= \ No newline at end of file diff --git a/.gitignore b/.gitignore index 9b5413c2..c5b9da16 100644 --- a/.gitignore +++ b/.gitignore @@ -5,7 +5,7 @@ __pycache__/ # C extensions *.so - +.env # Distribution / packaging .Python build/ diff --git a/README.md b/README.md index 59c32cc7..e4b472c2 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,13 @@ source NameOfRcFile.sh ~~~ #### Configuration -You can view all existing parameters in the [yaml file](VirtualMachineService/config/config.yml). +You can view (almost) all existing parameters in the [yaml file](VirtualMachineService/config/config.yml). Also you need to provide the path to your config file as the first param when starting a server. +Furthermore there are some parameters you can set in the [.env.in](.env.in) file, which are read only when starting with docker. +Important: You need to rename .env.in to .env in order for it to be read by docker. +When starting with commandline you will need to export some of them manually. + #### Security Groups The client expects a security group with the name "defaultSimpleVM" to exist which will be assigned to each machine at startup. Also, each machine will have its own security group when it starts. @@ -70,7 +74,7 @@ portal_client_start_server path/to/config.yml ~~~ ### Using Docker -Specify in the [.env](.env) file which release should be used by the client. +Specify in the .env file which release should be used by the client. Then you can start the client with: ``` $ docker-compose up diff --git a/docker-compose.yml b/docker-compose.yml index 4505497d..c0c86bd0 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,6 +13,7 @@ services: - OS_PASSWORD - OS_USER_DOMAIN_NAME - OS_PROJECT_DOMAIN_ID + - FORC_API_KEY volumes: - ./VirtualMachineService/config/config.yml:/code/VirtualMachineService/config.yml