1e99/passed
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add instructions for building from source

Browse source
This commit is contained in:
1e99 2024-10-30 17:17:29 +01:00
parent 9fe27528bb
commit a09962d73e
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -21,7 +21,8 @@ When someone views the password, PassED looks at the URL. It knows the password
This model ensures that a malicous host can not read the passwords. This model ensures that a malicous host can not read the passwords.
## Installation ## Installation
Installation is done with docker compose. Installation can be done with docker compose or from source.
### Docker Compose
```yaml ```yaml
services: services:
"passed": "passed":
@ -35,6 +36,21 @@ services:
- "3000:3000" - "3000:3000"
``` ```
### Source
1. Download the source code
```sh
git clone https://git.1e99.eu/1e99/passed.git
```
2. Ensure that you have go installed, if not follow this [guide](https://go.dev/doc/install).
3. Build the project
```sh
go build -o passed .
```
4. Run the project
```sh
PASSED_STORE_TYPE=dir ./passed
```
## Configuration ## Configuration
Configuration is done with environment variables. Configuration is done with environment variables.
- `PASSED_ADDRESS`: Specifies the address that PassED should listen on, defaults to `:3000` - `PASSED_ADDRESS`: Specifies the address that PassED should listen on, defaults to `:3000`