mirror of
https://github.com/aleleba/aleleba-vscode-dockerfile-configuration.git
synced 2025-01-09 05:06:46 -06:00
Making Breaking changes to use custom bash scripts. Updating to version 3.0.0
This commit is contained in:
parent
d596af8a2f
commit
66ed2b4950
GPG Key ID:
F48D7CDEB47942BD
@ -15,9 +15,6 @@ RUN sudo apt-get install -y jq
|
||||
RUN sudo apt-get update
|
||||
RUN sudo apt-get install dumb-init
|
||||
|
||||
RUN adduser --gecos '' --disabled-password vscode \
|
||||
&& echo "vscode ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd
|
||||
|
||||
RUN ARCH="$(dpkg --print-architecture)" \
|
||||
&& curl -fsSL "https://github.com/boxboat/fixuid/releases/download/v0.6.0/fixuid-0.6.0-linux-$ARCH.tar.gz" | tar -C /usr/local/bin -xzf - \
|
||||
&& chown root:root /usr/local/bin/fixuid \
|
||||
@ -47,8 +44,4 @@ RUN sudo sysctl -w fs.inotify.max_user_watches=524288
|
||||
ADD ./entrypoint.sh /usr/bin/entrypoint.sh
|
||||
RUN sudo chmod +x /usr/bin/entrypoint.sh
|
||||
|
||||
USER 1000
|
||||
ENV USER=vscode
|
||||
WORKDIR /home/vscode
|
||||
|
||||
ENTRYPOINT ["/usr/bin/entrypoint.sh"]
|
||||
111
entrypoint.sh
111
entrypoint.sh
@ -1,80 +1,71 @@
|
||||
#!/bin/bash
|
||||
set -eu
|
||||
|
||||
# Check if we are root
|
||||
if [ "$(id -u)" != "0" ]; then
|
||||
echo "This script must be run as root" 1>&2
|
||||
sudo bash -c "echo HOME_USER=$HOME_USER >> /etc/environment"
|
||||
sudo bash -c "echo VSCODE_TUNNEL_NAME=$VSCODE_TUNNEL_NAME >> /etc/environment"
|
||||
exec sudo bash -c "source /etc/environment; /usr/bin/entrypoint.sh"
|
||||
fi
|
||||
|
||||
if [[ -z "${HOME_USER-}" ]]; then
|
||||
HOME_USER="vscode"
|
||||
fi
|
||||
|
||||
# We do this first to ensure sudo works below when renaming the user.
|
||||
# Otherwise the current container UID may not exist in the passwd database.
|
||||
eval "$(fixuid -q)"
|
||||
if ! grep -q "HOME_USER=" /etc/environment; then
|
||||
sudo bash -c "echo HOME_USER=$HOME_USER >> /etc/environment"
|
||||
fi
|
||||
|
||||
if [ "${HOME_USER-}" ]; then
|
||||
USER="$HOME_USER"
|
||||
if [[ "${HOME_USER-}" != "vscode" ]]; then
|
||||
if ! id -u $HOME_USER > /dev/null 2>&1; then
|
||||
if ! grep -q "VSCODE_TUNNEL_NAME=" /etc/environment; then
|
||||
sudo bash -c "echo VSCODE_TUNNEL_NAME=$VSCODE_TUNNEL_NAME >> /etc/environment"
|
||||
fi
|
||||
|
||||
# List all environment variables
|
||||
sudo env |
|
||||
|
||||
# Filter variables that start with GLOBAL_ENV_
|
||||
grep -E '^GLOBAL_ENV_' |
|
||||
|
||||
# Exclude GLOBAL_ENV_HOME_USER and GLOBAL_ENV_VSCODE_TUNNEL_NAME
|
||||
grep -vE '^(GLOBAL_ENV_HOME_USER|GLOBAL_ENV_VSCODE_TUNNEL_NAME)=' |
|
||||
|
||||
# Remove the GLOBAL_ENV_ prefix
|
||||
sed 's/^GLOBAL_ENV_//' |
|
||||
|
||||
# Append the result to /etc/environment if not already present
|
||||
while IFS= read -r line
|
||||
do
|
||||
if ! grep -q "^${line%=*}=" /etc/environment; then
|
||||
echo "export $line" | sudo tee -a /etc/environment
|
||||
fi
|
||||
done
|
||||
|
||||
USER="$HOME_USER"
|
||||
if ! id -u $HOME_USER > /dev/null 2>&1; then
|
||||
sudo adduser --disabled-password --gecos "" ${HOME_USER}
|
||||
sudo echo "$HOME_USER ALL=(ALL) NOPASSWD:ALL" | sudo tee -a /etc/sudoers.d/nopasswd > /dev/null
|
||||
fi
|
||||
|
||||
sudo cp -R /home/vscode/. /home/${HOME_USER}/
|
||||
# List all environment variables
|
||||
sudo env |
|
||||
|
||||
# Check if .bashrc file exists
|
||||
if [ ! -f "/home/${HOME_USER}/.bashrc" ]; then
|
||||
# If not, create it
|
||||
sudo touch /home/${HOME_USER}/.bashrc
|
||||
fi
|
||||
# Filter variables that start with USER_ENV_
|
||||
grep -E '^USER_ENV_' |
|
||||
|
||||
# Change the owner of the .bashrc file to HOME_USER
|
||||
sudo chown ${HOME_USER} /home/${HOME_USER}/.bashrc
|
||||
# Remove the USER_ENV_ prefix
|
||||
sed 's/^USER_ENV_//' |
|
||||
|
||||
# Copy environment variables from vscode user to HOME_USER
|
||||
env | grep -v 'HOME_USER' | while read -r line; do
|
||||
sudo su - ${HOME_USER} -c "echo 'export $line' >> ~/.bashrc"
|
||||
# Append the result to /home/${HOME_USER}/.bashrc
|
||||
while IFS= read -r line
|
||||
do
|
||||
echo "export $line" | sudo tee -a /home/${HOME_USER}/.bashrc
|
||||
done
|
||||
|
||||
# Copy the .bashrc file from vscode user to HOME_USER
|
||||
sudo su - ${HOME_USER} -c "cat /home/vscode/.bashrc >> ~/.bashrc"
|
||||
|
||||
# Creating .vscode folder if it doesn't exist
|
||||
if [ ! -d "/home/${HOME_USER}/.vscode" ]; then
|
||||
sudo mkdir -p /home/${HOME_USER}/.vscode
|
||||
fi
|
||||
|
||||
# Changing the property of the directory /home/${HOME_USER}/.vscode
|
||||
sudo chown -R ${HOME_USER}: /home/${HOME_USER}/.vscode
|
||||
|
||||
# Changing the HOME_USER in the .bashrc file
|
||||
sudo su - ${HOME_USER} -c "sudo sed -i \"s|/home/vscode|/home/${HOME_USER}|g\" ~/.bashrc"
|
||||
|
||||
# Switch to the user specified by $HOME_USER and start an interactive shell session.
|
||||
sudo su -l ${HOME_USER}
|
||||
|
||||
# Copy the HOME variable from vscode user to HOME_USER
|
||||
sudo su -l ${HOME_USER} -c "echo \"export HOME=/home/${HOME_USER}\" >> ~/.bashrc"
|
||||
|
||||
# Source the .bashrc file to apply the changes immediately
|
||||
sudo su -l ${HOME_USER} -c "source ~/.bashrc"
|
||||
|
||||
# Delete the vscode user
|
||||
if id "vscode" &>/dev/null; then
|
||||
sudo chown -R vscode:vscode /home/vscode
|
||||
sudo userdel -r vscode
|
||||
fi
|
||||
else
|
||||
# Switch to the user specified by $HOME_USER and start an interactive shell session.
|
||||
sudo su -l ${HOME_USER}
|
||||
fi
|
||||
fi
|
||||
|
||||
# Then execute entrypoint.sh
|
||||
if [ "$HOME_USER" != "$(whoami)" ]; then
|
||||
exec sudo -u $HOME_USER bash -c "source /etc/environment; /usr/bin/entrypoint.sh"
|
||||
fi
|
||||
|
||||
# Find .sh files in /usr/bin/custom-scripts and execute them in order
|
||||
for script in $(find /usr/bin/custom-scripts -name "*.sh" | sort); do
|
||||
chmod +x $script
|
||||
sudo -u $HOME_USER bash -c "source /etc/environment; $script"
|
||||
done
|
||||
|
||||
|
||||
# Add LS_COLORS variable to .bashrc
|
||||
LS_COLORS_VALUE="rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:mi=00:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:*.tar=01;31:*.tgz=01;31:*.arc=01;31:*.arj=01;31:*.taz=01;31:*.lha=01;31:*.lz4=01;31:*.lzh=01;31:*.lzma=01;31:*.tlz=01;31:*.txz=01;31:*.tzo=01;31:*.t7z=01;31:*.zip=01;31:*.z=01;31:*.dz=01;31:*.gz=01;31:*.lrz=01;31:*.lz=01;31:*.lzo=01;31:*.xz=01;31:*.zst=01;31:*.tzst=01;31:*.bz2=01;31:*.bz=01;31:*.tbz=01;31:*.tbz2=01;31:*.tz=01;31:*.deb=01;31:*.rpm=01;31:*.jar=01;31:*.war=01;31:*.ear=01;31:*.sar=01;31:*.rar=01;31:*.alz=01;31:*.ace=01;31:*.zoo=01;31:*.cpio=01;31:*.7z=01;31:*.rz=01;31:*.cab=01;31:*.wim=01;31:*.swm=01;31:*.dwm=01;31:*.esd=01;31:*.jpg=01;35:*.jpeg=01;35:*.mjpg=01;35:*.mjpeg=01;35:*.gif=01;35:*.bmp=01;35:*.pbm=01;35:*.pgm=01;35:*.ppm=01;35:*.tga=01;35:*.xbm=01;35:*.xpm=01;35:*.tif=01;35:*.tiff=01;35:*.png=01;35:*.svg=01;35:*.svgz=01;35:*.mng=01;35:*.pcx=01;35:*.mov=01;35:*.mpg=01;35:*.mpeg=01;35:*.m2v=01;35:*.mkv=01;35:*.webm=01;35:*.ogm=01;35:*.mp4=01;35:*.m4v=01;35:*.mp4v=01;35:*.vob=01;35:*.qt=01;35:*.nuv=01;35:*.wmv=01;35:*.asf=01;35:*.rm=01;35:*.rmvb=01;35:*.flc=01;35:*.avi=01;35:*.fli=01;35:*.flv=01;35:*.gl=01;35:*.dl=01;35:*.xcf=01;35:*.xwd=01;35:*.yuv=01;35:*.cgm=01;35:*.emf=01;35:*.ogv=01;35:*.ogx=01;35:*.aac=00;36:*.au=00;36:*.flac=00;36:*.m4a=00;36:*.mid=00;36:*.midi=00;36:*.mka=00;36:*.mp3=00;36:*.mpc=00;36:*.ogg=00;36:*.ra=00;36:*.wav=00;36:*.oga=00;36:*.opus=00;36:*.spx=00;36:*.xspf=00;36:"
|
||||
sudo su - ${HOME_USER} -c "echo 'export LS_COLORS=\"$LS_COLORS_VALUE\"' >> ~/.bashrc"
|
||||
|
||||
60
readme.md
60
readme.md
@ -17,6 +17,28 @@ The following environment variables can be set when running the Docker container
|
||||
- `HOME_USER`: The username of the user running the container. This is used to set the correct permissions on files created in the container.
|
||||
- `VSCODE_TUNNEL_NAME`: The name of the SSH tunnel used by Visual Studio Code to connect to the container.
|
||||
|
||||
### Custom Environment Variables
|
||||
|
||||
You can set custom environment variables for the `HOME_USER` by using the `USER_ENV_` prefix when running the Docker container. These environment variables will be created in the `/home/${HOME_USER}/.bashrc` file without the `USER_ENV_` prefix.
|
||||
|
||||
For example, if you want to set a custom environment variable named `MY_VARIABLE` for the `HOME_USER`, you can do so by setting the `USER_ENV_MY_VARIABLE` environment variable when running the Docker container:
|
||||
|
||||
```bash
|
||||
docker run -it -e HOME_USER=custom-home-user -e USER_ENV_MY_VARIABLE=my_value -e VSCODE_TUNNEL_NAME=vscode-ssh-remote-server -v /path/to/extensions.json:/home/extensions.json aleleba/vscode
|
||||
```
|
||||
In this example, MY_VARIABLE will be set to my_value in the /home/${HOME_USER}/.bashrc file.
|
||||
|
||||
### Global Environment Variables
|
||||
|
||||
You can set global environment variables by using the `GLOBAL_ENV_` prefix when running the Docker container. These environment variables will be created in the `/etc/environment` file without the `GLOBAL_ENV_` prefix.
|
||||
|
||||
For example, if you want to set a global environment variable named `MY_GLOBAL_VARIABLE`, you can do so by setting the `GLOBAL_ENV_MY_GLOBAL_VARIABLE` environment variable when running the Docker container:
|
||||
|
||||
```bash
|
||||
docker run -it -e HOME_USER=custom-home-user -e GLOBAL_ENV_MY_GLOBAL_VARIABLE=my_global_value -e VSCODE_TUNNEL_NAME=vscode-ssh-remote-server -v /path/to/extensions.json:/home/extensions.json aleleba/vscode
|
||||
```
|
||||
In this example, MY_GLOBAL_VARIABLE will be set to my_global_value in the /etc/environment file.
|
||||
|
||||
### Adding VSCode Extensions
|
||||
|
||||
To add VSCode extensions to the container, create a JSON file with an array of objects containing the extension details you want to install, the only Mandatory field is uniqueIdentifier and follow this structure. For example:
|
||||
@ -81,23 +103,39 @@ You can run this `docker-compose.yml` file by navigating to the directory where
|
||||
|
||||
This will start the container in the background and output the container ID. You can then use the `docker ps` command to view the running container.
|
||||
|
||||
## Using this image as a base image in a Dockerfile
|
||||
## Adding Custom Scripts
|
||||
|
||||
To use this image as a base image in a Dockerfile, you can add the following line to the top of your Dockerfile and you can install any additional packages you need, here an example installing nvm and nodejs in a `Dockerfile`:
|
||||
In this project, you can add custom scripts that will be automatically executed when the application starts. The `/usr/bin/custom-scripts` directory in the Docker container is a volume that maps to a directory on your host machine. Here's how you can add a custom script:
|
||||
|
||||
### 1. Create a new script file
|
||||
|
||||
Create a new file with a `.sh` extension in the directory on your host machine that maps to the `/usr/bin/custom-scripts` volume in the Docker container. For example, if the `/usr/bin/custom-scripts` volume maps to the `./custom-scripts` directory on your host machine, you can create a file named `install_node.sh` in the `./custom-scripts` directory.
|
||||
|
||||
```bash
|
||||
touch ./custom-scripts/install_node.sh
|
||||
```
|
||||
FROM aleleba/vscode:latest
|
||||
|
||||
# Installing node.js and NVM
|
||||
SHELL ["/bin/bash", "--login", "-i", "-c"]
|
||||
RUN curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
|
||||
RUN nvm install --lts
|
||||
RUN nvm alias default lts/*
|
||||
SHELL ["/bin/sh", "-c"]
|
||||
RUN echo 'source ~/.nvm/nvm.sh' >> ~/.bashrc
|
||||
# Finishing installing node.js and NVM
|
||||
### 2. Write your script
|
||||
|
||||
Open the file in a text editor and write your script. Here's an example that installs Node.js using NVM:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# Installing Node.js with NVM
|
||||
curl -O https://raw.githubusercontent.com/creationix/nvm/master/install.sh
|
||||
bash install.sh
|
||||
source ~/.nvm/nvm.sh
|
||||
nvm install --lts
|
||||
nvm alias default lts/*
|
||||
nvm use default && npm install -g yo generator-code
|
||||
nvm use default && npm install -g @vscode/vsce
|
||||
```
|
||||
The #!/bin/bash line at the top of the script tells the system that this script should be run with the Bash shell.
|
||||
|
||||
### 3. Run your Docker container
|
||||
When you start your Docker container, all .sh files in the /usr/bin/custom-scripts directory will be automatically executed in alphabetical order. The environment variables from the /etc/environment file will be loaded before each script is executed.
|
||||
|
||||
Remember to replace install_node.sh with the name of your script and ./custom-scripts with the actual path to the directory on your host machine that maps to the /usr/bin/custom-scripts volume in the Docker container.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
@ -1 +1 @@
|
||||
2.0.58
|
||||
3.0.0
|
||||
Loading…
Reference in New Issue
Block a user