Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-19 16:13:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Michel Jonathan Schmitz
2019-07-25 09:58:43 +02:00
parent 19e556c76e
commit 74cd1a7ace
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -20,14 +20,14 @@ This project shows a very fast way to deploy [backend](https://gitlab.com/openst
an existing deployment of the TU Berlin).
With a running backend and database you should be able to run the [app](https://gitlab.tubit.tu-berlin.de/stapps/app)
With a running backend and database you should be able to run the [app](https://gitlab.com/openstapps/app)
with your deployment.
# Step by step to your own deployment
At first you need to install [docker](https://docs.docker.com/install/) and
[docker-compose](https://docs.docker.com/compose/install/). Then clone or download this repository. To download the
docker images from GitLab you have to be authenticated against GitLabs container registry. Please execute
`docker login gitlab-registry.tubit.tu-berlin.de`. The requested credentials are the same as for GitLab.
`docker login registry.gitlab.com`. The requested credentials are the same as for GitLab.
`docker login` stores the credentials the users home directory. If you plan to execute docker commands only from root
or via sudo you should run `docker login` with root or sudo as well.
@@ -74,7 +74,7 @@ docker-compose logs backend
The backend will find the database on `http://database:9200` inside the deployment network. As stated in the
`docker-compose.yml` the backend will expose port 3000 on the host. You should be able to request the backend for it's
configuration on http://localhost:3000.
configuration on http://localhost:3000 (or http://MY-IP-ADDRESS:3000).
Now you have a running backend that can be queried by the app. You could already try to the install the
@@ -84,7 +84,7 @@ backend doesn't provide any data by now.
There is no public deployment for the app version 2.0.0 by now. But you could copy some data from there.
To import some `SCPlace`'s you could run:
```sh
```shell
docker-compose run --rm api copy --appVersion 2.0.0 place <url-of-public-deployment> http://backend:3000 20
```
This will copy data using the [api](https://gitlab.com/openstapps/api) from the deployment of the TU Berlin to your
@@ -94,7 +94,7 @@ deployment.
On Linux you can execute a simple shell script that will run you through
steps above and copy some data in your deployment:
```sh
```shell
sh start.sh
```
@@ -103,7 +103,7 @@ sh start.sh
You now have your own deployment and can import some data from your university into the backend. To write your own
program to import data you should checkout the [minimal-connector](https://gitlab.com/openstapps/minimal-connector/)
This is a small program that shows the usage of the [api](https://gitlab.com/openstapps/api/) and imports some example
data from TypeScript code. Feel free to copy the [minimal-connector](https://gitlab.com/openstapps/minimal-connector/)
data from TypeScript code. Feel free to fork the [minimal-connector](https://gitlab.com/openstapps/minimal-connector/)
and write your own connector with it.
## Add your connector
@@ -128,11 +128,12 @@ This command will immediately start the service on execution.
## Round off your deployment with the [proxy](https://gitlab.com/openstapps/proxy)
The backend is exposed on the port 3000 now. This means anyone can import data into your backend and you can only run
one version of the backend at a time. Have a look at the [proxy](https://gitlab.com/openstapps/proxy/) to secure and
round off your deployment. The proxy will allow you to run multiple deployments for different app version on one server
and provide some static data like images for your university.
round off your deployment. The proxy will add a layer of security, allowing you to run multiple deployments for
different app version on one server and provide some static data like images for your university.
## Explore docker capabilities
Docker is a great tool with many great features. Have a look at the
[docker cli documentation](https://docs.docker.com/engine/reference/commandline/cli/) or our
[docker cheat sheet](https://gitlab.tubit.tu-berlin.de/stapps/projectmanagement/blob/master/DOCKER.md) to learn
[docker cheat sheet](https://gitlab.com/openstapps/projectmanagement/blob/master/project-docs/DOCKER_CHEAT_SHEET.md) to learn
more about it.