Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 2.1 KB

README.md

File metadata and controls

34 lines (22 loc) · 2.1 KB
Raw

anisette-servers

This is a central location for all officially recommended Anisette servers for use in SideStore.

Adding your own Anisette Server

To add your own Anisette server to the official list, your Anisette server must meet the following requirements:

  1. This will be a long term server. We don't want servers that will only be up for a short period of time.
  2. Uptime is important, if you cannot guarantee high uptime, please don't request for your server to be added.
  3. Your server should be an Anisette V3 server. We recommend SideStore/omnisette-server or Dadoum/anisette-v3-server.
  4. HTTPS is recommended, but not necessary.

To help increase the likelihood of your anisette server being listed, it is suggested that you tell us what anisette server you are running, and where it is being ran, for example: the cloud, your house, a workplace.

If your server meets these requirements, please do the following:

  1. Fork the repo, and open it in a code or text editor of some sort.
  2. Modify the servers.json file to include your server in the same format as the rest of the servers.
  3. Commit your changes to your fork.
  4. Make a Pull Request on the official repo requesting that your Anisette server is added.

Forking / Template Usage

If you would like to host your own repository list instead of adding a server to our list, that is fully supported as well!

  1. Use this repository as a template and ensure that Github Pages are enabled for your repository.
  2. Run the main Action to deploy your server list!

(Optional) To set up the optional cache key within the servers.json file, follow these steps:

  1. Ensure that your CNAME file is properly set up.
  • If you are using Github Pages without a custom domain, the contents should be <username>.github.io/<repository-name> (e.g. nythepegasus.github.io/anisette-servers)
  1. Ensure that you set the CREATE_CACHE_KEY variable to true within your repository's Actions variables.