Boilerplate for [Example Project]

In this boilerplate, we included the following packages out of the box:

• code-server for the VS Code in the browser
  • Add extensions here
• cloudflared for accessing other ports through to Cloudflare Argo Tunnel
• croc for sharing files between computers without that Mega.nz (or Telegram client) chaos
• jq for prettifying your JSON stuff, especially if parsing JSON responses from some APIs.
• Basics like curl, wget, and more.
• Add more tools here

This template repository is good for:

• people who want to start their own Code Server Boilerplates
• just want to have the bare minimum dependencies in their code-server instance.

Checklist

• Generate an new repo for an specific user case.
• Replace any placeholder references such as [Example Project] and code-server-boilerplates/starter-pack in README and also in toolkits/containers/README.md.
• Add your tools you want into Dockerfile. Just remember that anything requires systemd will not work (particularly Snaps and Flatpaks, AppImages are fine).
  • Repeat this on arm64.Dockerfile, just make sure tools you about to add have ARM64-compartible binaries/packages.
• Edit toolkits/virtual-machines/*bootstrapper scripts to include needed tools lile what you did in your Dockerfile (optional, but recommended). Now, feel free to add systemd-required tools like Snaps, just look for these lines.

############################################################
# Add your tools your users want to install on an fresh machine here ⬇

# For userland installs, like Node Version Manager,
# you may need to prefix "su coder" before the command.
# For global installs, nuke the sudo part since we're root.

# ...

# Add your tools your users want to install on an fresh machine here 
############################################################

• Update deployment docs in guides directory. Ensure that replace any https://cdrs-deploy.repohubdev.tk/<METHOD>/example-project into https://cdrs-deploy.repohubdev.tk/<METHOD>/<SLUGGIFIED-PROJECT-NAME-HERE>. (<METHOD> is either railway, heroku, or divio, but every PaaS with Dockerfile support should be fine)
• Have any referral links for Linode or Digital Ocean? Replace https://rtapp.tk/SERVICEHERE-thepinsteam into https://rtapp.tk/SERVICEHERE-yourusernamehere. Remember to create these shortlinks using our Kutt.it instance at https://rtapp.tk. (SERVICEHERE is either linode or digitalocean)
• Change Andrei Jiroh, Code Server Boilerplates maintainers, and its Contributors in LICENSE file into <Your name> and its Contributors if you prefer not to bring this template into the @code-server-boilerplates org. Otherwise, change it into <Your name>, Code Server Boilerplates maintainers, and its Contributors.
• Create an PAT using your account (service account is always preferred and we usually use them here). If you prefer not to, request for our service account's PAT and invite RecapTimeBot into your repi as an collaborator (or as an outside collaborator with write access). Remember that the PAT we gave to you is valid for 2 years and can be renewable, as long as you comply with the policies.
• Read any comments in .github/workflows/push-to-registry.yml` if there's needed changes.
• Adopt the Community Code of Conduct, which based on Contributor Convenant v2.0. If you prefer not to go to
• Finally, register your Code Server Boilerplate here and our robots will send you both an invite into @code-server-boilerplates org through mail and also an new issue in your repo on instructions.
• Cheer, you just made it here! Congratulate yourself!
  • Probably now create new boilerplates straight to the org or even join The Pins Team (it's optional btw, and if you're interested you'll be invited into @MadeByThePinsHub/Community-Hubs-Network-Board first by humans soon once you maintain atleast 3 boilerplates here, you can leave anytime) to help us maintain them, among other tasks.

Additional documentation for managing GitHub Actions workflows, issue templates and Dependabot are on this README. For base images we maintain for different Linux distros (Ubuntu, Arch Linux/Manjaro and Alpine), please see https://github.com/code-server-boilerplates/base-docker-images. The Debian base image in the root Dockerfile uses the official image from Coder called codercom/code-server in Docker Hub.

Deploy

Most deployment documentation are moved into the Guides section.

As an base image in your Dockerfile

In your Dockerfile, use code-server-boilerplates/starter-pack as your base image and then add your needed tools and finally the CMD ["cdr-launchpad-server] stuff at the end.

# Latest tag tracks the latest version of code-server
# Tags are formatted in form of BASE-IMAGE-NAME:cdr-<CODE-SERVER-VER>.<distro-version>
# e.g.: BASE-IMAGE-NAME:cdr-latest or cdr-latest.debian10
# For the base OS (we might do reproducible builds soon), use the format
# BASE-IMAGE-NAME:debian10 or BASE-IMAGE-NAME:ubuntu-latest (tl;dr: ubuntu-latest == latest LTS)
# Also using the latest tag will use the image we built using the same Dockerfile.
# where BASE-IMAGE-NAME is an image within code-server-boilerplates namespace
# in Docker Hub.
FROM code-server-boilerplates/starter-pack:latest

# ensures croc is up-to-date
RUN curl https://getcroc.schollz.com | sudo bash

# install our dotfiles
RUN git clone https://gitlab.com/MadeByThePinsHub/dotfiles /home/coder/.dotfiles
RUN bash /home/coder/.dotfiles/setup.sh --no-secrets-repo --noprompt --nosystemd

# finally, hit the road
CMD ["/usr/bin/cdr-launchpad-server"]

Virtual machines/private servers or containers?

• VMs are deployed once, and then can be modified to install new software
  • You need to save "snapshots" to use your latest images - Storage is always persistent, and you can usually add extra volumes
  • VMs can support many workloads, such as running Docker or Kubernetes clusters
  • Docs for the VM install script
• Deployed containers do not persist, and are often rebuilt
  • Containers can shut down when you are not using them, saving you money
  • All software and dependencies need to be defined in the Dockerfile or install script so they aren't destroyed on a rebuild. This is great if you want to have a new, clean environment every time you code
  • Storage may not be redundant. You may have to use rclone to store your filesystem on a cloud service, for info:
  • Docs for using the container image

License and Contributing

This repository's contents is licensed under the MIT License. By contributing to this repository, you agree to Developer's Certificate of Origin and The Pins Team Community Code of conduct.