WELCOME!

If you are seeing this page, congratulations! Your server is set up correctly.
Please go through Part 1 & 2 to get everything else running smoothly.

Visit S3zipper to get a managed version, or to get more information:

Visit S3zipper for more information.

To check errors and logs:

To see any s3zipper errors, check below link:
These logs were created initially to help monitor the stages of the zipping process.

s3zipper check logs(not your typical logs)

 tail /home/go/logs/log.txt 

PART 1 (API SERVER SETUP)

This server is pre-configured to use Caddy Web Server as a reverse proxy.
This means that you can easily get automatic HTTPS by providing a valid domain name.You can also use it as is with a public/elastic ip address.
These changes can be achieved through the (Caddyfile & dockerconfig.env) files.
NB : IMPORTANT

Please change the following settings in config.toml file to get local urls to work well.

            [liveconfig]
            uselive = true #Leave as is in production.
            baseurl = ""  #Use the right domain name or IP.
            usehttps = false #Use true if using HTTPS
            

Step 1 (Directory)

Internal Server address

 "localhost:8000" 

Home Directory

"/home/go" 

Change Directory to home

 "cd /home/go" 

Internal Server Config path

 "/home/go/config.toml" 

Caddyfile

 "/home/go/Caddyfile" 

Environment Variables

 "/home/go/dockerconfig.env" 

Docker Compose

 "/home/go/docker-compose.yml" 

Step 2 (Email Notification Setup)

To get email notifications, please provide email configuration settings in config.toml.

NOTE:
*Leave email field empty if you do not need notifications.
*You must provide correct email configurations to be able to use email, or else, an error will be triggered if you provide email with wrong configurations.

PART 2 (API & Usage)

For API documentation and usage:
Visit EC2(AMI) S3ZIPPER API SERVER API documentation

Available language examples in postman:
cURL, jQuery, Ruby, Python Requests, Node, PHP, Golang, etc.