estkme-cloud

README

eSTK.me Cloud Enhance Server

Introduction

This is a simple server designed to handle requests from the eSTK.me removable eUICC, such as downloads and notifications.

If you don't have an eSTK.me eUICC yet, you can get one from eSTK.me and use the coupon code eSIMCyou to receive a 10% discount.

Installation

You can download the binary release from the releases page or you can build it yourself.

If you want to build it yourself, you can run the following commands:

git clone git@github.com:damonto/estkme-cloud.git
cd estkme-cloud
go build -trimpath -ldflags="-w -s" -o estkme-cloud main.go

Sometimes, you might need to set executable permissions for the binary file using the following command:

chmod +x estkme-cloud

You must also install the following dependencies:

# Debian
apt-get install -y --no-install-recommends ca-certificates libpcsclite1 libcurl4
# Arch Linux
pacman -S pcsclite

Once done, you can run the server using the following command:

./estkme-cloud

If you want to change the default port, lpac version or data directory, you can use the following flags:

./estkme-cloud --help

Usage of estkme-cloud:
  -advertising string
        advertising message to show on the server (max: 100 characters)
  -dir string
        the directory to store lpac (default "/tmp/estkme-cloud")
  -dont-download
        don't download lpac
  -listen-address string
        eSTK.me cloud enhance server listen address (default ":1888")
  -version string
        the version of lpac to download (default "v2.0.1")
  -verbose
        verbose mode

If you wish to run the program in the background, you can utilize the systemctl command. Here is an example of how to achieve this:

1. Start by creating a service file in the /etc/systemd/system directory. For instance, you can name the file estkme-cloud.service and include the following content:

[Unit]
Description=eSTK.me Cloud Enhance Server
After=network.target

[Service]
Type=simple
User=your_user_here
Restart=on-failure
ExecStart=/your/binary/path/here/estkme-cloud
RestartSec=10s
TimeoutStopSec=30s

[Install]
WantedBy=multi-user.target

1. Then, use the following command to start the service:

systemctl start estkme-cloud

1. If you want the service to start automatically upon system boot, use the following command:

systemctl enable estkme-cloud

Docker

You can also run the server using Docker. You can use the following command to run the server:

docker run -d --name estkme-cloud -p 1888:1888 damonto/estkme-cloud:latest
# or use the GitHub Container Registry
docker run -d --name estkme-cloud -p 1888:1888 ghcr.io/damonto/estkme-cloud:latest

How To Use

Once the server is running, the server will listen on the specified port (default: 1888) and you can send requests to the server.

To use community servers deployed in multiple regions, use:

cloud.estk.me

Download

To download a profile, you should enable the Cloud Enhance feature on the eUICC and set the server listening address to the server address. The server will handle the download request and download the profile to the eUICC.

The server support downloading profiles with confirmation code and custom IMEI.

If your eSIM provider requires a confirmation code, you can use the following activation code format:

LPA:1$SM-DP+$Matching Id$$<confirmation_code>

Please replace <confirmation_code> with the actual confirmation code.

If your eSIM provider requires a custom IMEI, you can use the following activation code format:

1. With confirmation code:

LPA:1$SM-DP+$Matching Id$$<confirmation_code>#<custom_imei>

1. Without confirmation code:

LPA:1$SM-DP+$Matching Id#<custom_imei>

Please replace <custom_imei> with the actual IMEI.

You can also use the following command to consume your cellular data:

data$<amount_of_data_in_KiB>

Please replace <amount_of_data_in_KiB> with the actual data amount.

Notification

If you click the "Process Notification" button on the eSTK.me eUICC, the server will receive a notification request and send all notifications.

Please note that:

1. All enable, disable and install notifications will be deleted after sending.

2. The delete notifications will be kept in your eSTK.me eUICC.

Donate

If you like this project, you can donate to the following addresses:

USDT (TRC20): TKEnNtXGvfQEpw1jwy42xpfDMaQLbytyEv

USDT (Polygon): 0xe13C5C8791b6c52B2c3Ecf43C7e1ab0D188684e3

Your donation will help maintain this project and our community server.