Install Portfolio-synode

This document is the 0.7.0 demo version. Some function in the UI is still in developing.

Prerequisit

Portfolio-synode requires Python 3.9 and JDK 17.

For Linux, please also install Exiftool.

Follow the document or use apt to install:

sudo apt install exiftool

And make sure “exiftool -ver” is running.

The services are acturally started by command:

java -jar bin/jserv-album-0.7.0.jar
java -jar bin/html-service-0.1.1.jar

Please make sure your JDK is running.

Install Steps

  1. Download synode registry, registry.zip from the project’s releas page.

    Unzip the Synode registry.

    Portfolio Synode 0.7.0 can only work as a stand alone service node. Registry is used in the future for synchronizing register.

  2. Download jserv-album-0.7.1.zip or check lastest version at the project’s releas page.

  3. Unzip in a floder, say, protfolio-synode

  4. Setup Portfolio-synode’s Python module

    in portfolio-synode, run:

    pip install bin/synode_py3-0.7-py3-non-any.whl

    To check if it’s installed successfully, run:

    pip show synode.pye

  5. Start Portfolio-synode

    Don’t run this in VS Code Termnial in Linux. See the issue & troubleshootings if you have to, while it’s recommended to run this in VS Code in Windows.

    Run

    python3 -m src.synodepy3

    • Click the top button for opening registry dir.

      User Id, password and Login function are not available in demo version. Leave the fields untouched.

    • Click Setup if everything is OK.

    • Click Start. The data service should be running now.

      Or run “java -jar bin/jserv-album-#.#.#.jar” in the folder.

    There should be a QR Code showing in the GUI. You can scan with a Portfolio client, e.g. the Portfolio Android, to connect to this service node.

    ../_images/00-portfolio-synode.png

  6. Test Run

    • Check firewall configurations

      Protfolio-synode by default will listening on TCP port 8964, the data service, and port 8900, the web page server.

    • Open the webpage in a browser

      Open the home page for listing uploaded files, e.g.:

      url: http://127.0.0.1:8900

      There should be the files once are uploaded with Portfolio Android.

    ../_images/07-portfolio-web.png

  7. Install Windows Services

    Portfolio-Synode must be installed as Windows serices if is running in Windows. Click the install Windows Service button to install. This process requires administrator permission, which will asks for 4 times, 2 separate service for Web pages and data service, each requires a install and a start permissions.

    Please also be aware of the permission confirmation’s dialogs can be hidden behind current Window.

Uninstall Portfolio-synode

  • For Windows:

In CMD Termnial, or VS Code Bash Termnial,

# cd portfolio-synode
synode-uninstall-srv

This will uninstall the Windows services.

Then uninstall python modules:

pip uninstall synode.py3
pip uninstall anson.py3

No it’s safe to delete the portfolio-synode folder. The files saving location is specified by the volume path. You can delete the folder if you don’t need the files anymore.