Skip to content

Latest commit

 

History

History
106 lines (63 loc) · 5.69 KB

README.md

File metadata and controls

106 lines (63 loc) · 5.69 KB

App Server

administer-org - app-server stars - app-server forks - app-server

GitHub tag License issues - app-server Hits-of-Code

What is it?

The App Server is a FastAPI/MongoDB program which stores apps for use in Administer and a website later on, there is no backend panel or anything. What you see is what you get.

Installation Prerequisites

Install python3 3.13 and pip.

In addition to that, make sure you have a MongoDB instance which runs locally ONLY without a password. Because it will not have a password, exposing it to the internet is a bad idea.

Installation

Standard installation (recommended)

Just clone the repo and run the installer:

git clone https://github.com/administer-org/app-server

cd app-server

chmod +x Install_AOS.sh
./Install-AOS.sh

AOS and a systemd unit will be installed automatically.

Development installation

Run the following (assuming you already have python3 and pip):

pip install uv

uv venv

# Enter the venv.. it varies from OS to OS so if this doesn't work just run the command it tells you to
source .venv/bin/activate

uv pip install .

And you're done! Make sure to edit your __aos__.json and config.json files, then run aos.

Privacy

Last Modified: 3/25/25

Administer is designed with privacy as a top priority. We only collect the data necessary to operate this service, and this data is never accessed by anyone other than the system itself. All information is securely stored in an internal MongoDB instance and is never read, shared, or sold by Administer staff. Specifically, we only collect your Roblox Place ID and the apps you install to ensure safety for the rating system.

To ensure platform safety, we may log requests if you attempt to misuse our API; for example, creating fake places, impersonating a game server, or engaging in other forms of abuse. In such cases, we will log the following information:

  • Timestamp
  • Basic IP details (country, ISP, IP, proxy information, state/region)
  • Attempted Roblox ID
  • User-Agent string

Important: This data is only collected if abusive behavior is detected. For legitimate usage, such as within Roblox game servers, no IP information is sent to permanent storage. Abusing the service will result in permanent blockage, and such decisions are typically final unless there is compelling evidence of error.

If you believe you were wrongly flagged and recieved a "This incidient will be reported" message in error, please contact us to resolve the issue and remove your information from our logs.

The only information we include by default is your Administer version for analytics. It is stored in aggregate and your Roblox Place ID is not associated with any data. For example, we do collect:

  • Aggregate counts of every place in the database (for knowing how many users we have overall)
  • Administer version data from every panel (for knowing how new versions are being adopted and if its safe to remove old AOS features)
  • Individual place IDs and what apps you installed and have votes for (This is never read by any staff manually or automatically. Eventually we are looking to encrypt this data.)

We do not collect:

  • How many times your individual game uses Administer
  • The commands/apps you regularly use
  • Your usage of Administer features, settings, apps, etc.
  • Your game's admin/rank structure
  • Any other information from your game or Administer

Indivudually, we collect:

  • your roblox place ID
  • the timestamp that you sent your first request
  • the apps you have installed (in order to provide voting)
  • your votes and favorites

If we change this policy (for example opt-in detailed analytics, comments on apps, ...), you will be notified via the Discord server, core panel (if it's significant), and other appropriate channels.

When a request is made, we log the IP, Roblox place ID (if any), timestamp, request method, status code, server processing time, and any other request-speicifc logs. This is for debugging. The logs are purged weekly at midnight and are generally not read unless there is a service disruption caused by the backend code.

Contributions

We welcome contributions as long as they are meaningful. Please ensure you are familiar with our code standards and libraries before making pull requests. For larger changes, you may want to discuss a change in our Discord beforehand.

License

All of Administer and your usage of it is governed under the GNU AGPL 3.0 license.

Administer Team 2024-2025-2025