Docker version developed and maintained by https://github.com/vaughngx4. PLEASE NOTE: Currently, the application is created to run in development mode WITH debugging on by default, as well as having several API vulnerabilities. This is a potential security issue and I would advise to not expose the application(ports 8000 and 8080) or the API(ports 3000 - 3004) to the internet.
Clone source code and cd into directory:
git clone https://github.com/socioboard/Socioboard-5.0.git
cd Socioboard-5.0Build docker images from source:
chmod +x docker-build.sh
./docker-build.shBuilding images may take some time depending on your internet speed. Build can fail due to slow connections.
Create .env and change variables(I use vi but use whatever text editor you have):
cp docker/.env.example docker/.env
vi docker/.envNOTE 1: Twilio API is required for the user API(registration, login etc.) to work. Fill correct details(You can create a free acount here: https://www.twilio.com/try-twilio)
Twilio Account SID and Auth Key can be found in the API Keys section. To get a Service ID you will need to go the Twilio Console click on Verify, then Services and create a SocioBoard service.
NOTE 2: If running behind a reverse proxy or exposing ports other than the default, be sure to change the URL scheme in the # apply configs to config files section of docker/socioboard/init.sh
Create and start containers:
docker-compose -f docker/docker-compose.yaml up -dCheck the status of the container by running:
docker logs socioboardOnce services are running, we can check the logs using:
docker exec -it socioboard su-exec socioboard pm2 logsCTRL+C to exit
A data/api directory will be created inside the docker folder(you can change the docker mount in docker-compose.yaml to put it elsewhere). This is only for init files so that a new container would not try to initialize an existing database.
The docker network IP is not important and can be changed freely.
If for example port 8000 on your machine is in use and you want to change the frontend to port 8989. You will need to edit docker/docker-compose.yaml and change "8000:8000" to "8989:8000". You will also need to change the URL scheme in docker/socioboard/init.sh to match.
Navigate to your endpoint(`http://localhost:8000 by default) and create a new user by signing up. You will receive a message in the top right corner stating "Registration Failed - Unauthorized", this means you've registered but the activation link could not be emailed(no email set up).
There are 2 ways to edit users:
The following command will manually activate ALL users as well as assign the highest available package and set expiry date to a much later date (30th December 2999 i.e ~never). Replace username, password and database with those set in .env earlier:
docker exec -it socioboard-mysql sh -c "mysql --user=scbadmin --password=sqlpass --database=scbsql < /perma-act-users.sql"There is now an optional admin panel(enabled by default, but can be disabled via .env) that is served on port 8080 at /admin (http://localhost:8080/admin by default). Default login details are - email: admin@scb.example and password: scb@123. I recommend you change these in the .env file as well.
After logging in, click on your database(there should only be 1 database). Scroll down to the User Activations section(table), find your user(you can match users based on the data in User Details section(table)), click the 3 dots to the right of the user and click on edit. Here you can set Activation Status (0 means not activated, 1 means activated), User Plan (ranges from 0 to 7) and Account Expire Date.
Done! You can now log in :)
To bring down containers without affecting data run the following in the source directory:
docker-compose -f docker/docker-compose.yaml down
To remove all containers and data we need to remove volumes and init files like so:
docker-compose -f docker/docker-compose.yaml down --volumes
sudo rm -rf docker/data