Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Set up your local environment (with docker)

Note

Prerequisites

The following procedure assumes you have docker installed on your machine

Docker environment

Clone project https://bitbucket.org/wediaproduct/docker-compose-template-gul/src/master/

This repository contains a docker compose template for running the whole WEDIA application.
Make sure to read the README.md.

It is recommended to use this repository as a template that you can easily update (git pull).
→ Do not run your project from this cloned repository.

Init a project environment

Follow these steps every time you need to setup a new environment

...

:

  • Copy the docker-compose-template folder to your own projects folder:
    Assuming you cloned the repository in ~/git-repositories/wedia-docker-template and you store your projects in ~/projects, and you want to start project projectWedia

    Code Block
    languagebash
    cd ~
    cp -R ./git-repositories/wedia-docker-template ./my-projects/projectWedia
  • Delete content of folders san, db and admin:

    Code Block
    languagebash
    cd ~/my-projects/projectWedia
    rm -rf ./san/*
    rm -rf ./admin/*
    rm -rf ./db/*
  • Start the whole docker environment (assuming ports 8080, 8000, 8888, are not used)

    Code Block
    languagebash
    docker compose up

    At this point, your server is started, you can start configuring it manually.

  • Init environment using predefined script
    In order to ease the basic configuration of the platform, we provide a JS project: https://bitbucket.org/wediaproduct/wedia_auto_installer/src/master/. Clone this repository, then:
    First time, init the project

    Code Block
    languagebash
    npm i

    Then you can finalize an environment configuration by running:

    Code Block
    languagebash
    npm run config

Start a project environment

Follow these steps every time you need to switch from one environment to another:

  • stop all your containers

    Code Block
    languagebash
    docker kill $(docker ps -q)
  • move to environment folder

    Code Block
    languagebash
    cd ~/my-projects/projectWedia
  • start environment

    Code Block
    languagebash
    docker compose up

Init security settings

Cloud environments

MediaCloud setup

Do not forget to ask for a MediaCloud Wedia ID to ESAAS team. This is a requirements for:

  • Artificial intelligence features

  • Players

  • Video transcriptions

  • Documents transcriptions

Email server setup

Do not forget to ask ESAAS team to configure the smtp server, and to make sure the cloud environment is allowed to connect this server.