kato
/
FreePad
mirror of https://github.com/JustKato/FreePad.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

* Removed "Building" section

This commit is contained in:
Daniel Legt 2022-05-18 22:57:18 +03:00
parent 2abcaa0599
commit 57c4bcf063
1 changed files with 1 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -30,69 +30,4 @@ The `.env` file contains all of the available options and you should use it to c
If you need any help with any setting you can always open an issue over on github and get help from me.
If you are barely getting started with hosting your own services, or even Sys admin stuff in general or writing code my suggestion is to just copy `.env` and leave it as is until you get it running with the defaults running fine, afterwards you can play with it a little and who knows, maybe even get to learn something!
![Gopher](static/img/banner_building.png)
## From Source
Building from source isn't exactly recommended as it's a hasle
```bash
# Clone the repo
git clone https://github.com/JustKato/FreePad FreePad
# Get in it!
cd FreePad
# Install golang
sudo apt install golang # Obviously use your distro's package manager
# Run the build Script
./build.sh
# Check out the ./dist folder
cd ./dist
# Make sure you change settings here
cp ../.env.example ./.env
# Run the program
./freepad
```
## Running the Binary
```bash
# Download the latest version of FreePad
freepad.1.0.3.zip
# Extract to wherever
unzip freepad.1.0.3.zip
# Get into the directory
cd FreePad
# ( Optionaly but recommended ) Edit the .env file
vim .env
# Run the program
./freepad
```
## Starting with Docker-Compose [ WIP ]
```bash
# Copy the example docker-compose file to anywhere
wget https://raw.githubusercontent.com/JustKato/FreePad/master/docker-compose.example.yaml
# Yoink the example .env file while we're at it
wget https://raw.githubusercontent.com/JustKato/FreePad/master/.env.example
# Rename the files
mv docker-compose.example.yaml docker-compose.yaml
mv .env.example .env
# ! Please take a look at the files and edit them before running
docker-compose up -d;
```
If you are barely getting started with hosting your own services, or even Sys admin stuff in general or writing code my suggestion is to just copy `.env` and leave it as is until you get it running with the defaults running fine, afterwards you can play with it a little and who knows, maybe even get to learn something!