{"id":23477492,"url":"https://github.com/rwth-acis/mobsos-surveys","last_synced_at":"2025-04-14T20:22:24.942Z","repository":{"id":16784240,"uuid":"19542605","full_name":"rwth-acis/mobsos-surveys","owner":"rwth-acis","description":"A simple survey management service and Web application, being part of the MobSOS toolkit. ","archived":false,"fork":false,"pushed_at":"2022-11-05T12:57:58.000Z","size":4134,"stargazers_count":7,"open_issues_count":8,"forks_count":10,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-28T08:41:23.116Z","etag":null,"topics":["java"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rwth-acis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-07T16:53:37.000Z","updated_at":"2022-12-09T21:23:03.000Z","dependencies_parsed_at":"2023-01-13T20:31:00.735Z","dependency_job_id":null,"html_url":"https://github.com/rwth-acis/mobsos-surveys","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fmobsos-surveys","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fmobsos-surveys/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fmobsos-surveys/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fmobsos-surveys/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rwth-acis","download_url":"https://codeload.github.com/rwth-acis/mobsos-surveys/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248952685,"owners_count":21188487,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java"],"created_at":"2024-12-24T18:27:16.286Z","updated_at":"2025-04-14T20:22:24.912Z","avatar_url":"https://github.com/rwth-acis.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"MobSOS Surveys\n==============\n[![Build Status](https://travis-ci.org/rwth-acis/mobsos-surveys.svg?branch=master)](https://travis-ci.org/rwth-acis/mobsos-surveys)\n\nA simple RESTful service for managing, conducting, and evaluating online surveys, including a template-based responsive Web frontend. The service is based on [las2peer](https://github.com/rwth-acis/LAS2peer).\n\nRequirements\n--\n\n  * Installed Java 8 JDK \n  * Installed Gradle 7.3\n  * Installed [mySQL 5](http://www.mysql.com/)\n  \nBuild\n--\n\nFirst, initialize the MobSOS Surveys database:\n\n```\nmysql -u \u003cADMINUSER\u003e -p \u003c etc/sql/schema.sql\n```\n\nThen, build MobSOS Surveys:\n\n```\ngradle build\n```\n\nStart\n--\n\nTo start MobSOS Surveys, use one of the available start scripts:\n  \n  * `bin/start_network.bat (Win)`\n  * `bin/start_network.sh (Unix, Mac)`\n\nAfter successful start, MobSOS Surveys is available under\n\nhttp://localhost:8080/mobsos-surveys\n\nHow to run using Docker\n-------------------\n\nFirst build the image:\n```bash\ndocker build . -t mobsos-surveys\n```\n\nThen you can run the image like this:\n\n```bash\ndocker run -e MYSQL_USER=myuser -e MYSQL_PASSWORD=mypasswd -p 8080:8080 -p 9011:9011 mobsos-surveys\n```\n\nReplace *myuser* and *mypasswd* with the username and password of a MySQL user with access to a database named *mobsos*.\nBy default the database host is *mysql* and the port is *3306*.\nThe Web UI will be available via *http://localhost:8080/mobsos-surveys* and the las2peer node is available via port 9011.\n\nIn order to customize your setup you can set further environment variables.\n\nDocker has a known [issue for mac with Apple chip](https://docs.docker.com/desktop/mac/apple-silicon/). Some images do not support the ARM64 architecture. We can add `--platform Linux/amd64` to run (or build) an Intel image using emulation.\n\n### Node Launcher Variables\n\nSet [las2peer node launcher options](https://github.com/rwth-acis/las2peer-Template-Project/wiki/L2pNodeLauncher-Commands#at-start-up) with these variables.\nThe las2peer port is fixed at *9011*.\n\n| Variable | Default | Description |\n|----------|---------|-------------|\n| BOOTSTRAP | unset | Set the --bootstrap option to bootrap with existing nodes. The container will wait for any bootstrap node to be available before continuing. |\n| SERVICE_PASSPHRASE | processing | Set the second argument in *startService('\u003cservice@version\u003e', '\u003cSERVICE_PASSPHRASE\u003e')*. |\n| SERVICE_EXTRA_ARGS | unset | Set additional launcher arguments. Example: ```--observer``` to enable monitoring. |\n\n### Service Variables\n\nVariables for service configuration.\n\n| Variable | Default |\n|----------|---------|\n| MYSQL_USER | *mandatory* |\n| MYSQL_PASSWORD | *mandatory* |\n| MYSQL_HOST | mysql |\n| MYSQL_PORT | 3306 |\n| EP_URL | http://localhost:8080/mobsos/surveys/ |\n| STATIC_CONTENT_URL | \"\" |\n| OIDC_SCHEMA | openidconnect |\n| OIDC_PROVIDER_NAME | Learning Layers |\n| OIDC_PROVIDER_LOGO | https://api.learning-layers.eu/logo.png |\n| OIDC_PROVIDER_URL | https://api.learning-layers.eu/o/oauth2 |\n| OIDC_CLIENT_ID | f405d2a1-d4a3-4b6a-abab-65896c1167dc |\n| QUESTIONNAIRE_SCHEMA_PATH | ./doc/xml/mobsos-questionnaire.xsd |\n\n### Web Connector Variables\n\nSet [WebConnector properties](https://github.com/rwth-acis/las2peer-Template-Project/wiki/WebConnector-Configuration) with these variables.\n*httpPort* and *httpsPort* are fixed at *8080* and *8443*.\n\n| Variable | Default |\n|----------|---------|\n| START_HTTP | TRUE |\n| START_HTTPS | FALSE |\n| SSL_KEYSTORE | \"\" |\n| SSL_KEY_PASSWORD | \"\" |\n| CROSS_ORIGIN_RESOURCE_DOMAIN | * |\n| CROSS_ORIGIN_RESOURCE_MAX_AGE | 60 |\n| ENABLE_CROSS_ORIGIN_RESOURCE_SHARING | TRUE |\n| OIDC_PROVIDERS | https://api.learning-layers.eu/o/oauth2,https://accounts.google.com |\n\n### Other Variables\n\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DEBUG  | unset | Set to any value to get verbose output in the container entrypoint script. |\n\n### Volumes\n\nThe following places should be persisted in volumes in productive scenarios:\n\n| Path | Description |\n|------|-------------|\n| /src/node-storage | Pastry P2P storage. |\n| /src/etc/startup | Service agent key pair and passphrase. |\n| /src/log | Log files. |\n\n*Do not forget to persist you database data*\n\nDependencies\n---\nThe service uses [MobSOS questionnaire elements](https://github.com/rwth-acis/mobsos-questionnaire-elements) for some components\n\nLicense\n--\nMobSOS Surveys is freely distributable under the [MIT License](https://github.com/rwth-acis/mobsos-survey/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fmobsos-surveys","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwth-acis%2Fmobsos-surveys","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fmobsos-surveys/lists"}