Skip to content
Sharkhex

Sharkhex Classifieds

Documentation

Everything to install, run and extend Sharkhex Classifieds.

Getting started

  • Product overview

    Who uses the marketplace, what visitors, sellers, businesses and administrators do in it, how it is built, and what makes each install its own brand.

  • Docker deployment

    Run one marketplace on one server with Docker: the files, the first start, the volumes, a theme of your own, updates and logs.

  • Backend installation

    Install the backend by hand: requirements, the steps from the code to the first admin, the background worker, the web server and the first sign-in.

  • Installs and updates

    Versions, a new install, updating to a newer release, what survives an update, and going back.

  • Scheduled jobs

    The commands the worker runs on a schedule, what stops working without them, a crontab for servers without a worker, and the commands to run by hand.

  • Deployment checklist

    What to check before opening a marketplace: the server, email, the brand, the catalogue and the optional services.

Running the platform

  • Platform configuration

    The settings in the admin, the marketplace templates, categories and their fields, business accounts, jobs and professionals, places, pages and themes.

  • Admin guide

    The admin panel day to day: the dashboard, listings and moderation, the catalogue, businesses and professionals, users, places, content and the system pages.

  • Payments

    What sellers can pay for, Stripe, NETOPIA and PayPal, orders and refunds, and dealer plans.

  • Troubleshooting

    Common problems and their fixes: email, photos, the health check, uploads, Facebook sign-in, phone verification, settings that do not show and interrupted updates.

Apps and clients

  • Mobile app setup

    What the iOS and Android app uses, the server settings it needs, and what each brand provides.

  • New client instance

    The repeatable path to a client's own marketplace: the accounts they own, the server and install, the brand, the catalogue, content, services, the app and opening.

Developers

  • API and integrations

    The API the app uses, with its documentation, and the outside services the platform talks to.

Found a mistake? Tell us.