Skip to content

Commit

Permalink
Merge branch 'main' into fix-host-key-validation
Browse files Browse the repository at this point in the history
  • Loading branch information
MightyMoud committed Sep 22, 2024
2 parents 55bd244 + 5eaadf4 commit 5184970
Show file tree
Hide file tree
Showing 14 changed files with 36 additions and 36 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ First you need a VPS with Ubuntu LTS. I recommend DigitalOcean. Hetzner also get

Just make sure the following is true:
- VPS running Ubuntu - LTS recommended
- SSH Public Key availble on your machine to login to VPS.
- SSH Public Key available on your machine to login to VPS.

That's it!
### VPS Setup
Expand All @@ -60,9 +60,9 @@ sidekick init
Then you need to enter the following:
- IP Address of your VPS
- An email address to use for setting up SSL certs
- Docker registery to host your docker images - defaults to `docker.io`
- Docker username in the said registery
- Confirm you are currently logged in to that said registery with the username - This is needed to be able to push images on your behalf
- Docker registry to host your docker images - defaults to `docker.io`
- Docker username in the said registry
- Confirm you are currently logged in to that said registry with the username - This is needed to be able to push images on your behalf

After that Sidekick will setup many things on your VPS - Usually takes around 2 mins

Expand All @@ -85,7 +85,7 @@ After that Sidekick will setup many things on your VPS - Usually takes around 2
<img width="500px" src="/demo/imgs/launch.png">
</div>

In your application folder, make sure you have a working `Dockerfile` that you can build and run. Also make sure you know at which port your app is expecting to recieve traffic.
In your application folder, make sure you have a working `Dockerfile` that you can build and run. Also make sure you know at which port your app is expecting to receive traffic.

Then run:
```bash
Expand All @@ -103,8 +103,8 @@ Should take around 2 more mins to be able to visit your application live on the
<summary>What does Sidekick do when I run this command</summary>

* Build your docker image locally for linux
* Push the docker image to the registery
* Encrpt your env file, if available and push it to your VPS
* Push the docker image to the registry
* Encrypt your env file, if available and push it to your VPS
* Use sops to dycrpt your env file and start and env with the values injected
* Spin up your docker image using docker compose and route traffic to it using Traefik on the specified port
</details>
Expand All @@ -129,7 +129,7 @@ This command will also do a couple of things behind the scenes. You can check th

* Build your docker image locally for linux
* Compare your latest env file checksum for changes from last time you deployed your application.
* If your env file has changed, sidekick will re encrypt it and replace the encrypte.env file on your server.
* If your env file has changed, sidekick will re encrypt it and replace the encrypted.env file on your server.
* Deploy the new version with zero downtime deploys so you don't miss any traffic.
</details>

Expand All @@ -151,7 +151,7 @@ sidekick deploy preview
* Build your docker image locally for linux
* Tag the new image with the short checksum of your git commit
* Compare your latest env file checksum for changes from last time you deployed your application.
* If your env file has changed, sidekick will re encrypt it and replace the encrypte.env file on your server.
* If your env file has changed, sidekick will re encrypt it and replace the encrypted.env file on your server.
* Add a new folder inside your app folder called "preview" where Sidekick will store and manage all your preview deployments
* Deploy a new version of your app reachable on a short hash based subdomain
</details>
Expand Down
4 changes: 2 additions & 2 deletions cmd/deploy.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions cmd/env.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions cmd/init.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
6 changes: 3 additions & 3 deletions cmd/launch.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down Expand Up @@ -40,7 +40,7 @@ var launchCmd = &cobra.Command{
os.Exit(1)
}

if utils.FileExists("./dockerfile") {
if utils.FileExists("./Dockerfile") {
pterm.Info.Println("Dockerfile detected - scanning file for details")
} else {
pterm.Error.Println("No dockerfiles found in current directory.")
Expand Down
4 changes: 2 additions & 2 deletions cmd/preview.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions cmd/root.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions render/render.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions utils/scripts.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions utils/spinner.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions utils/stages.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions utils/types.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
4 changes: 2 additions & 2 deletions utils/utils.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
Copyright © 2024 Mahmoud Mosua <m.mousa@hey.com>
Licensed under the GNU AGPL License, Version 3.0 (the "License");
Licensed under the GNU GPL License, Version 3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.gnu.org/licenses/agpl-3.0.en.html
https://www.gnu.org/licenses/gpl-3.0.en.html
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down

0 comments on commit 5184970

Please sign in to comment.