Skip to content

Commit

Permalink
Merge pull request #38 from cryptpad/readme_update
Browse files Browse the repository at this point in the history
Added some details re: prerequisites, installation, embedding etc.
  • Loading branch information
wginolas authored Oct 21, 2024
2 parents 6da61db + 2b49316 commit e66541a
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,14 @@ files edited in CryptPad.

## Installation

You can install this app in one of the following ways: either from the NextCloud app store, from a binary release, or by cloning this repository. Once installed, you can check CryptPad is configured correctly by checking that the url listed under Administration > CryptPad is the same as the url of your local CryptPad instance.

### Prerequisites on the CryptPad side

To embed CryptPad into Nextcloud, the "Enable remote embedding" admin setting
needs to be enabled. You can find this setting on the "Administration" web
interface in the "General" tab.
interface in the "Security" tab.


### Install from Nextcloud app store

Expand Down Expand Up @@ -81,15 +84,15 @@ interface in the "General" tab.
}
```

### Verify binary release
#### Verify binary release

To verify the binary release you run the following command:

``` shell
openssl dgst -sha512 -verify openincryptpad.pubkey -signature openincryptpad.tar.gz.signature openincryptpad.tar.gz
```

## Clone from repo
### Clone from repo
Place this app in **nextcloud/apps/**. Make sure the folder is named `openincryptpad`. E.g.:

``` sh
Expand All @@ -99,7 +102,12 @@ git clone https://github.com/cryptpad/nextcloud-open-in-cryptpad.git openincrypt

## Building the app

The app can be built by using the provided Makefile by running:
Prior to building, install the requisite dependencies by running:

npm ci


The app can then be built using the provided Makefile by running:

make

Expand All @@ -121,6 +129,16 @@ The make command will install or update Composer dependencies if a composer.json
}
```

## Running the Nextcloud server

Before running Nextcloud, ensure you have an up-to-date version of PHP installed in the `nextcloud` repository, and run the following commands:

git switch v29.0.7 --detach
git submodule update --init

Then, to run the server:

php -S localhost:8080

## Publish to App Store

Expand Down

0 comments on commit e66541a

Please sign in to comment.