DOCSEARCHbyAlgolia
Submit Docs

Seatplus Documentation

website·Indexed 31 days ago

https://seatplus.net/

Documentation for Seatplus, a docker-based corporation management tool. Includes guides on installation, hardware requirements, configuration of PUID and PGID, updating to v4.x, and features for corporation member tracking, recruitment, and SSO scopes.

Tokens
4.9K
Snippets
36
Records
57
Agent score
59%

What's inside Seatplus

  1. Overview of Seatplus member management

    Seatplus is a rewrite of SeAT designed for recruiters and corporation management. Key features include a redesigned role and affiliation concept, independence from SDE (Static Data Export), friend lists, member compliance tracking for scopes and refresh tokens, instant role assignment, and automatic role assignment based on corporation or alliance membership.

  2. Install the Seatplus development environment

    The Seatplus development environment uses a combination of docker-compose and Traefik to mirror the production container architecture. Prerequisites include Docker, docker-compose, git, and PHP.
    # Create installation directory
mkdir seatplus && cd seatplus

# Clone the base-app repository
git clone https://github.com/seatplus/base-app .

  3. Seatplus core architecture components

    Seatplus is built upon several key libraries that can be used independently or as part of the main application:

    • Seatplus/eveapi: The main library for the application.
    • Seatplus/esi-client: A standalone ESI (Eve Swagger Interface) Client Library that utilizes kevinrob/guzzle-cache-middleware for caching.
    • Seatplus/auth: Provides authentication features for custom web interfaces or integrations.

  4. Access character management views

    Seatplus provides dedicated views for managing various character-specific data, including:

    • Character Contacts
    • Character Contracts
    • Character Wallets
    • Character Skills

  5. View detailed asset slots for ships and containers

    Seatplus provides an Asset Details view that allows users to review the specific slots and contents of ships, containers, and other assets.

  6. Track corporation member status and compliance

    Directors and users with the appropriate permissions can monitor corporation members to track the following details: SSO scopes compliance status, location, ship, joined date, and last login activity.

  7. Manage SRP requests as an SRP Officer

    SRP Officers are responsible for reviewing and processing payout requests. During the review process, officers can:

    • Modify individual item prices (which automatically updates the total).
    • Manually modify the total ISK amount.
    • Add notes for the user or other reviewers.
    • Accept or reject the SRP request.

  8. Apply for a job posting as a recruit

    Potential recruits can view all open enlistments on the home tab immediately after logging in. Once a recruit applies to a job posting, they are automatically enlisted and must fulfill the required SSO scopes to proceed.

  9. Create a new SeatPlus package using the skeleton

    For developers creating a brand new package from scratch, SeatPlus provides a package skeleton repository to standardize the structure.
    # Clone the skeleton repository to start your own package
git clone https://github.com/seatplus/package-skeleton/

  10. Install Docker and Docker Compose on Ubuntu

    While official installation is recommended, a convenience script is available for Ubuntu-based systems to install both Docker and Docker Compose in one step.
    curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

  11. Install the SeatPlus SRP plugin

    The SRP plugin enables users to submit loss mail and allows SRP Officers to manage and process payouts. To install the package, use Composer and run the database migrations.
    composer install seatplus/srp
php artisan migrate

  12. Contribute to seatplus development

    seatplus is a hobby project developed by Herpaderp Aldent. Contributions in the form of development, testing, and documentation are welcomed. The project primarily utilizes a stack consisting of Laravel, Vue.js, Inertia, and Tailwind CSS. Potential contributors can help by providing PHP expertise, Vue.js development, writing JavaScript tests (which are currently lacking), or by submitting bug reports and feature requests.