swg-server-docker/README.md

swg-docker

This project sets up a development environment for SWG using Docker.

Instructions:

1. Clone this repository.
2. (Optional) To use a custom git repository for the server source, create a file named .env in this directory. See the "Custom Repository" section below for details.
3. Run docker compose up -d --build to build the images and start the services.
4. Run docker exec -it swg bash to log into a shell in the swg container.
5. Run ant swg to compile the game and the assets. You only need to do this once, the first time you run the server.
6. Run ant start to run the server.

Completely wiping your local Docker environment

docker compose down -v

This will remove all the volumes, including the database and the swg-main project directory. You will have to recompile the project all over again.

Shutting down your Container, Safely, Without Loss

docker compose down

This will shut down the container, but it will keep the volumes, i.e., your database will stay, and your swg-main project directory will be kept intact.

Custom Repository

You can configure the Docker build to pull the swg-main source from your own repository. Create a file named .env in the root of this project and add the following variables as needed.

Example .env file:

# .env file for custom repository configuration

# The full HTTPS URL to your git repository.
# If left unset, it defaults to https://github.com/SWG-Source/swg-main.git
REPO_URL=https://github.com/SWG-Source/swg-main.git

# (Optional) Credentials for private repositories.
# For security, it is highly recommended to use a Personal Access Token instead of your actual password.
# If you do not need a username or password then ignore adding these lines.
REPO_USERNAME=your-gitlab-username
REPO_PASSWORD=your-personal-access-token

# (Optional) Credentials for the oracle DB user/pass, otherwise DO NOT add these 2 lines.
DB_USER=swg
DB_USER_PASSWORD=swg