Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make the docs more verbose #3926

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions cli/config.yaml.example

This file was deleted.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_account.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_account_add.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_account_get-token.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_account_list.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_account_update.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin_delete-user.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin_disable-2fa.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin_disable-passkey.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin_get-user-id.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin_list-users.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_admin_update-subscription.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_auth.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_auth_decrypt.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_export.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/docs/generated/ente_version.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/internal/promt.go
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ func ValidateDirForWrite(dir string) (bool, error) {
}

func ResolvePath(path string) (string, error) {
if path[:2] != "~/" {
if path[:1] != "~/" {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for changing this? Don't know if this will be backward compatible change

return path, nil
}
home, err := os.UserHomeDir()
Expand Down
14 changes: 11 additions & 3 deletions docs/docs/self-hosting/guides/standalone-ente.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,24 @@ createuser -s postgres

## Start Museum

```sh
Lets start by cloning Ente to your server/local system.

```sh
git clone https://github.com/ente-io/ente
```

The next step is to setup the Environment `ENTE_DB_USER` to postgres user which we created in the previous step. If needed, you can always add the line `export ENTE_DB_USER=postgres` to you shell's RC file to avoid doing it manually every time.

```
export ENTE_DB_USER=postgres
cd ente/server
go run cmd/museum/main.go
```

For live reloads, install [air](https://github.com/air-verse/air#installation). Then you can just call air after declaring the required environment variables. For example,

```sh
ENTE_DB_USER=ente_user
```
ENTE_DB_USER=postgres
air
```

Expand Down