Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Set up your local environment (with docker)

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

    cd ~
cp -R ./git-repositories/wedia-docker-template ./my-projects/projectWedia

  • Delete content of folders san, db and admin:

    cd ~/my-projects/projectWedia
rm -rf ./san/*
rm -rf ./admin/*
rm -rf ./db/*

  • For M1 (arm) platform compatibility

In the ~/my-projects/projectWedia/docker-compose.yml, replace the mysql image (image: mysql:8.0.26) by image: mysql/mysql-server.

  • Start the whole docker environment (assuming ports 8080, 8000, 8888, are not used)

    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

    npm i

    Then you can finalize an environment configuration by running:

    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

    docker kill $(docker ps -q)

  • move to environment folder

    cd ~/my-projects/projectWedia

  • start environment

    docker compose up

Init security settings

Security settings are initialized from the PACKAGED_Security plugin:

From <your wedia server>/admin/plugin/view?action=edit&name=PACKAGED_Security

  • Browse to Business Services tab

  • Open the swagger doc for com.wedia.packaged.security.extensions.PackagedSecurityAdminApi

  • Open /api/packaged/admin/security/update

  • Click Try it out

  • Click Execute

Initializing the portal application

To prepare the portal application, you need to clone the wediaproduct / portal repository

Once done, you will need to setup some basic information.

Make sure you are running on the appropriate node version (16)

run the following command

npm run wediaportal -- init

This will create a .wediaportalrc file at the root of your project.

You will need to adapt generated content for your project.

The .wediaportalrc file replaces .env files that were used before.

If you are migrating from a previous version of the portal without a .wediaportalrc file, you can automatically generate the .wediaportalrc file based on your .env files

npm run wediaportal -- restore

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.

Configure your DAM

Quickly configure a DAM

Starter kit comes with a workflow, and rights and roles, ready to use.

Once your starter kit is set up on a server : focus your efforts on the following points to set up your new DAM quickly.

1. Asset Metadata : Adapt the starter kit data model

Related documentation :

2. UI Design : configure colors, logos, notification emails…

Related documentation :

3. Home Page : configure images slider, widgets, and footer

Related documentation :

4. TOS acceptation

Related documentation : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2558754817/Introduction+to+terms+and+condition+of+use+management+interface

Related documentation :

6. Universes Menu : configure the universes menu

Related documentation :

7. Top filter bar & advanced search

Related documentation :

8. Display modes : configure metadata displayed in the list layout of the dam

Related documentation :

Display mode, List Layout : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2119303349/Display+Modes#Configuring-metadata-displayed-in-the-list-layout-of-the-dam-explorer

9. Asset details : configure metadata displayed

Related documentation :

Asset details : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2148270879/Asset+details+page#Asset-details-area

10. Init roles

Related documentation :

Make sure you have a correct understanding of Starter kit role types and role management interface by reading the associated documentation : Introduction to role management interface

Init the roles → Introduction to role management interface | 6. Init of roles

DAM Configuration : go further

The product documentation gives information for each DAM pages about :

  • How it works

  • Available configuration options and technical steps for the implementation

All the documentation available is under https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2116255749/Portal+screens+configuration

Feedbacks

You cannot find what you are looking for ?

Please leave us a comment so that we can improve the documentation !

You liked the documentation ?

Please give a like !

  • No labels