Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Commit

Permalink
update readme, x-forc-key in .env
Browse files Browse the repository at this point in the history
  • Loading branch information
eKatchko committed Dec 11, 2019
1 parent 2d5e1c2 commit ff0caab
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 4 deletions.
1 change: 0 additions & 1 deletion .env

This file was deleted.

2 changes: 2 additions & 0 deletions .env.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CLOUD_CLIENT_TAG=
FORC_API_KEY=
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ __pycache__/

# C extensions
*.so

.env
# Distribution / packaging
.Python
build/
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ff0caab

Please sign in to comment.