Skip to content

Latest commit

 

History

History
148 lines (98 loc) · 5.05 KB

local_development.md

File metadata and controls

148 lines (98 loc) · 5.05 KB

Local Development with MediaFlux

Instructions to download MediaFlux as a Docker container and run it locally.

Prerequisites

  • Docker: Make sure Docker is installed and running locally.

If you have a previous Docker image

Stop the current Docker container and remove both the container and the image used to create it:

docker stop mediaflux
docker rm mediaflux
docker rmi pulibraryrdss/mediaflux_dev:latest

You can use docker images to find out the exact name of the image to delete. You can also use the docker desktop to delete the image and container.

Load the new Docker image

  1. Log in to docker # See Ansible Vault for docker hub username and password, or check lastpass under "RDSS Docker"
export DOCKERHUB_USERNAME="username here"
export DOCKERHUB_PASSWORD="password here"
echo "$DOCKERHUB_PASSWORD" | docker login --username $DOCKERHUB_USERNAME --password-stdin

  1. create a container with an image from docker hub (notice we name it mediaflux)

    You can get the list of tag numbers from Docker Hub

docker create --name mediaflux --platform linux/amd64 --mac-address 02:42:ac:11:00:02 --publish 8888:80 pulibraryrdss/mediaflux_dev:{tag_number}

NOTE: You might need to tweak the platform parameter to --platform linux/arm64 depending on the architecture of your machine.

  1. From now on when you need start this container you can use:
docker start mediaflux
  1. Once the container is running you can access it at the default endpoints:
  1. You can stop the container in the Docker dashboard or via
docker stop mediaflux

and restart it via and it will preserve your changes (e.g. the assets that you added)

docker start mediaflux

Initializing the new Mediaflux

Remember that this is a brand new Mediaflux and therefore you'll need to recreate the schema

bundle exec rake schema:create

and re-exectute the Aterm command so that the Desktop shows collections properly:

actor.grant :type user :name system:manager :role -type role desktop-experimental

and recreate any collections and namespaces that you need.

SSHing into the container

Once the container is running we can SSH into it, this is useful to look at the logs of the running MediaFlux server:

docker exec -it mediaflux /bin/bash
root@12345:/setup#

The logs are found under the /usr/local/mediaflux/volatile/logs folder.

If for some reason you need to manually launch MediaFlux server you can use a command as follows:

root@12345:/setup# /usr/bin/env java -jar /usr/local/mediaflux/bin/aserver.jar application.home=/usr/local/mediaflux nogui

Accessing the thick client (Aterm)

  1. Get a copy of aterm.jar to run locally. While the container is running run the following cURL command to download it:
curl -OL http://0.0.0.0:8888/mflux/aterm.jar
  1. Run it
java -jar aterm.jar
  1. At the login screen, change "server" to 0.0.0.0 and "port" to 8888. Use the default domain, user, and password information.

See Aterm for beginners for more information on Aterm.

Test Projects and Assets

There are a few ways to generate test projects and test assets. The simplest is to run the rake task projects:create_small_project. For example rake projects:create_small_project\[cac9,mytest] will create a project for the user cac9 under the prefix mytest and create a random amount of assets underneath.

You can also utilize the TestAssetGenerator in the rails console to add assets to an existing project. For example the following script grabs the first User in the system and the last Project in the system. It then saves the project to mediaflux and then generates a hierarchy of assets under the project.

rails c
  user = User.first
  project = Project.last
  project.save_in_mediaflux(session_id: SystemUser.mediaflux_session)
  gen = TestAssetGenerator.new(project_id: project.id,user:, levels: 2, directory_per_level: 2,file_count_per_directory: 20)
  gen.generate

You can also utilize Mediaflux::TestAssetCreateRequest to generate some assets in an existing collection under a project

rails c
  parent_id = 1234 # collection id from mediaflux
  gen = Mediaflux::TestAssetCreateRequest.new(session_token: SystemUser.mediaflux_session, parent_id:, count: 5, pattern: "test_asset_" )
  gen.resolve

Internal documentation

All notes below are internal and cannot be accessed outside of the PUL IT group.