SVOCat Documentation

Version 3.1, April 2025, author: Carlos Rodrigo, Raúl Gutiérrez

HomeDownloadDocumentationExamplesCreditsHelp-Desk
1. Introduction
2. Install Docker version
3. The files
4. Example
5. Configure
    5.1. First
    5.2. Project
    5.3. Mysql
    5.4. Web
    5.5. VO options
    5.6. Fields
    5.7. Photometry
    5.8. Search Opts.
    5.9. File Paths
    5.10. Scripts
    5.11. Registry
    5.12. Spectra
    5.13. Links
    5.14. References
6. Edit
7. Web Design
    7.1. style.css
    7.2. Colors
    7.3. header.php
    7.4. footer.php
8. Extra tips
Previous   Next

Preconfigured Docker Compose version

We have created convenient Docker images for both the web server and the database. Both images are available at Docker Hub. Refer to Docker installation for installation instructions for different operating systems. Once you have Docker installed in your host machine, you can quickly set up a SVOcat service by using the next docker compose file:

  services:
    web:
      image: opensvo/svocat:web-2.2
      container_name: svocat-web
      ports:
        - "8080:80"
      volumes:
        - /your/path/to/catalogue/data/files:/data
      depends_on:
        - db
    db:
      image: opensvo/svocat:db-2.2
      container_name: svocat-db
      restart: always
      environment:
        MARIADB_ROOT_PASSWORD: changeme
        MARIADB_DATABASE: vocats
      volumes:
        - /your/path/to/host/db/directory:/var/lib/mysql
      user: <uid>:<gid>

In order to use this docker compose configuration, create a file with this content and call it:

docker-compose.yaml
. You have to change the values to match your needs. Specify the uid and gid numbers, as they will be the ones used to create the DB files on disk. You can obtain those values for your current user executing:

> id

Once you have configured the file at your convenience, you can run the server executing:

> docker compose up

If everything starts ok, you can stop the server (CTRL-C) and run subsequent executions with --detach option to leave the server running in background:

> docker compose up --detach

This will create and run two containers: svocat-db and svocat-web, and the web service will be available at port 8080 (this is configured in the docker-compose.yaml file).

 

IMPORTANT! By default, a user called catuser is created in the DB, with password as catp@ss. You are encouraged to change it by connecting to the DB container and running:

> docker exec -it svocat-db bash
# mariadb -u root -p
MariaDB> SET PASSWORD FOR 'catuser'@'%' = PASSWORD('whatever');

In svocat-web container you will find a directory called /data, where the data files of your machine under /your/path/to/catalogue/data/files will be available for ingestion. In order to connect to the container and perform the ingestions, just execute:

> docker exec -it svocat-web bash

The ingestion is done as explained in the section Example, with minor changes to the command, consisting in adding -h svocat-db to specify the db server name. For example:

> cd /data > mysql -h svocat-db -u catuser -p vocats < create_table.my

Previous   Next