Setting Up - BBloggsbott/ProfileServer GitHub Wiki

Setting up is very simple for Profile server. Download the latest jar from the releases tab. Move the jar file to any location in your drive. Let's call this location the working_directory.

In your working_directory, you must have one file called settings.json with the following content.

{
  "base_directory": ".",
  "data_directory": "data",
  "files_directory": "files",
  "pages_directory": "pages",
  "profile_file": "profile.yml",
  "navigation_file": "navigation.yml",
  "email": "[email protected]",
  "profile_image_size": "250px",
  "datetimeformat": "dd-MM-yyyy"
}

Fields and their functionality

  • base_directory - This is the directory where all the necessary files and directories used by the Profile Server (except settings.json) exists.
  • data_directory - This directory contains the navigation_file and profile_file exist. This path must be relative to base_directory
  • files_directory - This directory contains all the media files that you want to directly access from the server. More information on this in the Serving Files section. This path must be relative to base_directory
  • pages_directory - This directory contains all the pages (blog-like pages) you want to serve from the server. More information on this in the Serving Pages section. This path must be relative to base_directory
  • profile_file - This file holds information about the profile you want to server. More information on this in the Profile File section. This path must be relative to data_directory
  • navigation_file - This file holds information about the navigation panel you might want to use. More information on this in the Navigation File section. This path must be relative to data_directory
  • email - This email is used to generate Gravatar image when your avatar is not specified in profile_file
  • profile_image_size - Used for the image size when using Gravatar image
  • datetimeformat - The date format used to parse the dates in your pages.

The releases have a sample_setup.zip with all this already setup and ready to use.